PORT-7257 | Add the Upbound EKS as a service use case to our docs #1221
+1,296
−0
Conversation
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 pull request is automatically being deployed by Amplify Hosting (learn more). |
MPTG94
requested changes
May 27, 2024
| @@ -0,0 +1,1296 @@ | |||
| # Port and Upbound capabilities guide | |||
There was a problem hiding this comment.
Suggested change
| # Port and Upbound capabilities guide | |
| # EKS as a service action (EKSaaS) |
There was a problem hiding this comment.
@lordsarcastic please also update the file name
| @@ -0,0 +1,1296 @@ | |||
| # Port and Upbound capabilities guide | |||
| This is a guide for preparing a test environment to showcase Port + Upbound capabilities, both as a software catalog and self-service hub for developers, and a platform management tool for the platform team. | |||
There was a problem hiding this comment.
Suggested change
| This is a guide for preparing a test environment to showcase Port + Upbound capabilities, both as a software catalog and self-service hub for developers, and a platform management tool for the platform team. | |
| This is a guide to integrate Port and Upbound, using their combination as a software catalog and self-service hub for developers, and a platform management tool for the platform team. |
| At the end of this guide, you should be able to interact with Upbound using Port, provide EKSaaS using Upbound's capabilities and control planes as a backend, while reporting data regarding deployed clusters back to Port. | ||
|
|
||
| :::note Clean slate start | ||
| The demo starts off on a completely clean slate - an empty Upbound organization, an empty git repository, and a clean Port environment. |
There was a problem hiding this comment.
Suggested change
| The demo starts off on a completely clean slate - an empty Upbound organization, an empty git repository, and a clean Port environment. | |
| The demo starts off on a completely clean slate - an empty Upbound organization, an empty Git repository, and a basic Port environment. |
| <h3>Upbound</h3> | ||
| Before following the guide, you will need to set up an Upbound organization, initialize it and keep track of some information: | ||
| - Save the `Organization ID` for later; | ||
| - Set up the default EKSaaS configuration in the Upbound organization; |
There was a problem hiding this comment.
This needs more of an explanation on what it means
| - Save the `Organization ID` for later; | ||
| - Set up the default EKSaaS configuration in the Upbound organization; | ||
| - Deploy a control plane (or many) and save their `identifiers` for later; | ||
| - Create an API token and save it for later. |
There was a problem hiding this comment.
Are there Upbound docs we can link to that show how to create an API token?
| "org": "CHANGE_TO_YOUR_GITHUB_ORG_NAME", | ||
| "repo": "CHANGE_TO_YOUR_REPO_NAME", | ||
| "workflow": "new-cluster-request.yaml", | ||
| "workflowInputs": { |
There was a problem hiding this comment.
Same comments as previous Port SSA
| "org": "CHANGE_TO_YOUR_GITHUB_ORG_NAME", | ||
| "repo": "CHANGE_TO_YOUR_REPO_NAME", | ||
| "workflow": "delete-cluster.yaml", | ||
| "workflowInputs": { |
There was a problem hiding this comment.
Same comments as previous Port SSA
| ### Creating Upbound control plane Port entities | ||
| After setting up the Port blueprints and actions, we need to insert some entities manually. | ||
|
|
||
| These entities will represent the different Upbound control planes which were created earlier. |
There was a problem hiding this comment.
Suggested change
| These entities will represent the different Upbound control planes which were created earlier. | |
| These entities will represent the different Upbound control planes which you created in your Upbound organization. |
| 2. Click the `Manually add Upbound Control Plane` button (or the `+ Upbound Control plane` at the top right of the page). | ||
| <img src='/img/create-self-service-experiences/setup-backend/github-workflow/examples/Upbound/addUpboundControlPlaneManually.png' border='1px' /> | ||
|
|
||
| 3. In the `identifier` field, insert the Upbound control plane `identifier` which we saved earlier and click create (do this step multiple times if there are more than 1 control planes). |
There was a problem hiding this comment.
Suggested change
| 3. In the `identifier` field, insert the Upbound control plane `identifier` which we saved earlier and click create (do this step multiple times if there are more than 1 control planes). | |
| 3. In the `identifier` field, insert the Upbound control plane `identifier` which we saved earlier and click create (do this step multiple times if there is more than one control plane). |
| <img src='/img/create-self-service-experiences/setup-backend/github-workflow/examples/Upbound/setUpboundControlPlaneIdentifier.png' border='1px' /> | ||
|
|
||
| ## Using Port | ||
| At this point, everything should be set up. Browse to your [Self-service](https://app.getport.io/self-serve) page to view the different actions you defined in Port, and try them out. |
There was a problem hiding this comment.
Add an explanation about the example flows that are available using these actions:
- Create an EKS cluster from Port (as a Port admin/platform engineer)
- Request an EKS cluster from Port (as a Port member/developer)
- Approve an EKS cluster request
- Deny an EKS cluster request
- Delete an EKS cluster
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Added Upbound EKS as a service to the docs
Added docs pages
docs/create-self-service-experiences/setup-backend/github-workflow/examples/Upbound/upbound-port-capabilities.md)