-
Notifications
You must be signed in to change notification settings - Fork 606
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Service Catalog GitLab integration #8329
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,2 @@ | ||
* Discovery {% if include.discovery_support == true %}is{% else %}isn't{% endif %} supported by this integration | ||
* Discovery {% if include.discovery_default == true %}is{% else %}isn't{% endif %} enabled by default | ||
* Bindable entities: {{ include.bindable_entities }} | ||
* Discovery mechanism: {{ include.mechanism }} | ||
* Automatic resource discovery {% if include.discovery_support == true %}is{% else %}isn't{% endif %} supported by this integration | ||
* Resource types: {{ include.bindable_entities }} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: GitLab Integration | ||
content-type: reference | ||
beta: true | ||
|
||
discovery_support: true | ||
bindable_entities: "Projects" | ||
--- | ||
|
||
_Type: External_ | ||
|
||
The GitLab integration allows you to associate your {{site.service_catalog_name}} service to one or more [GitLab projects](https://docs.gitlab.com/ee/user/get_started/get_started_projects.html). | ||
|
||
For each linked project, the UI can show a **Project Summary** with simple data pulled from the GitLab API, such as the number of open issues, open merge requests, contributors, languages, and latest releases. | ||
|
||
## Prerequisites | ||
|
||
* You need the [Owner GitLab role](https://docs.gitlab.com/ee/user/permissions.html) to authorize the integration. This is required for event ingestion. | ||
* Only [GitLab.com subscriptions](https://docs.gitlab.com/ee/subscriptions/gitlab_com/) are supported at this time | ||
|
||
## Authorize the GitLab integration | ||
|
||
1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. | ||
2. Select **GitLab**, then **Install GitLab**. | ||
3. Click **Authorize**. | ||
|
||
## View GitLab specs in Service Catalog | ||
|
||
You can map specs to a Service Catalog service and view them in {{site.konnect_short_name}}. | ||
|
||
1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Services](https://cloud.konghq.com/us/service-catalog)**. | ||
2. Select a service, then open the **API Specs** tab. | ||
2. Click **Add API Spec**. | ||
3. Choose GitLab as the **Source**, then pick your spec and name it. | ||
|
||
Once it's uploaded, you can view the rendered spec on the API Specs tab in structured (UI), YAML, or JSON format, and download it in either YAML or JSON format. | ||
|
||
## Resources | ||
|
||
Entity | Description | ||
-------|------------- | ||
Projects | Organizes all the data for a specific development project that relates to a Service Catalog Service. | ||
|
||
## Events | ||
|
||
This integration supports events. | ||
|
||
You can view the following event types for linked projects from the {{site.konnect_product_name}} UI: | ||
|
||
* Opened merge requests | ||
* Merged merge requests | ||
|
||
|
||
## Discovery information | ||
|
||
<!-- vale off--> | ||
|
||
{% include_cached service-catalog-discovery.html | ||
discovery_support=page.discovery_support | ||
discovery_default=page.discovery_default | ||
bindable_entities=page.bindable_entities | ||
mechanism=page.mechanism %} | ||
|
||
<!-- vale on--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: there's info here that's not user-facing and some that's no longer relevant (cc @miko-bautista)
Bindable entities
is close tobinding
which is a term we're trying to move away from externally. Instead, use "Resources" and/or "Resource Types"I think this section can be as concise as:
Rest of the docs look great! 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Drew-Kimberly Thanks for the feedback! Since this is reusable content that is used by multiple integrations, I removed the 1st and 4th bullets, and reworded the remaining two per your suggestions.