AWS devopsagent documentation change
Summary
Updated documentation to add support for GitHub Enterprise Server, including prerequisites, setup steps, and management instructions for both GitHub.com and GitHub Enterprise Server instances.
Security assessment
The changes are feature enhancements adding support for GitHub Enterprise Server with detailed setup instructions. There is no evidence of addressing a specific security vulnerability, weakness, or incident. The mention of private connections for non-publicly accessible instances is a standard connectivity option, not a security fix.
Diff
diff --git a/devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md b/devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md index 8075850b5..24de31859 100644 --- a//devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md +++ b//devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md @@ -10,0 +11,2 @@ GitHub integration enables AWS DevOps Agent to access code repositories and rece +AWS DevOps Agent supports both GitHub.com (SaaS) and GitHub Enterprise Server (self-hosted) instances. + @@ -23,0 +26,11 @@ Before connecting GitHub, ensure you have: +For GitHub Enterprise Server, you also need: + + * A GitHub Enterprise Server instance (version 3.x or later) accessible over HTTPS + + * The HTTPS URL of your GitHub Enterprise Server instance (for example, `https://github.example.com`) + + * (Optional) A private connection, if your GitHub Enterprise Server instance is not publicly accessible + + + + @@ -56 +69,13 @@ On the "Register GitHub Account / Organization" screen, select whether you're co -### Step 3: Complete GitHub OAuth flow +If you are connecting to a GitHub Enterprise Server instance, check the **Use GitHub Enterprise Server** checkbox and enter the HTTPS URL of your instance (for example, `https://github.example.com`). + +If your GitHub Enterprise Server instance is not publicly accessible, you can optionally configure a private connection to allow AWS DevOps Agent to securely reach your instance. For more information, see [Connecting to privately hosted tools](./configuring-capabilities-for-aws-devops-agent-connecting-to-privately-hosted-tools.html). + +###### Note + + __Do not include`/api/v3` or any trailing path in the URL — enter only the base URL. + +### Step 3: Set up the GitHub App + +Click **Submit** to begin the app setup process. The next steps differ depending on whether you are connecting to GitHub.com or GitHub Enterprise Server. + +#### For GitHub.com @@ -58 +83 @@ On the "Register GitHub Account / Organization" screen, select whether you're co - 1. Click **Submit** to initiate the GitHub authentication flow + 1. You'll be redirected to GitHub to install the AWS DevOps Agent GitHub app. @@ -60 +85 @@ On the "Register GitHub Account / Organization" screen, select whether you're co - 2. You'll be redirected to GitHub to install the AWS DevOps Agent GitHub app + 2. Select which account or organization to install the app in. @@ -62 +87 @@ On the "Register GitHub Account / Organization" screen, select whether you're co - 3. Select which account or organization to install the app in + 3. The app allows AWS DevOps Agent to receive events from connected repositories, including deployment events. @@ -64 +88,0 @@ On the "Register GitHub Account / Organization" screen, select whether you're co - 4. The app allows AWS DevOps Agent to receive events from connected repositories, including deployment events @@ -67,0 +92 @@ On the "Register GitHub Account / Organization" screen, select whether you're co +#### For GitHub Enterprise Server @@ -69 +94 @@ On the "Register GitHub Account / Organization" screen, select whether you're co -### Step 4: Select repositories +GitHub Enterprise Server uses a GitHub App Manifest flow, which automatically sets up a new GitHub App on your instance. This involves two redirects to your GitHub Enterprise Server instance. @@ -71 +96,14 @@ On the "Register GitHub Account / Organization" screen, select whether you're co -Choose which repositories to allow the app to access: + 1. Your browser will be redirected to your GitHub Enterprise Server instance's "Create GitHub App" page. + + 2. You'll see the app name pre-filled. Feel free to change the name as needed. Click **Create GitHub App**. + + 3. You'll be redirected back to AWS DevOps Agent, which exchanges the manifest code for app credentials. + + + + +### Step 4: Select repositories and complete installation + + 1. You'll see the **Install & Authorize** page for the GitHub App. + + 2. Select which repositories to allow the app to access: @@ -75 +113 @@ Choose which repositories to allow the app to access: - * **Select repositories** – Choose specific repositories from your account or organization + * **Only select repositories** – Choose specific repositories from your account or organization @@ -76,0 +115 @@ Choose which repositories to allow the app to access: + 3. Click **Install & Authorize**. @@ -77,0 +117 @@ Choose which repositories to allow the app to access: + 4. You'll be redirected back to the AWS DevOps Agent console, where GitHub will appear as registered at the account level. @@ -80 +119,0 @@ Choose which repositories to allow the app to access: -### Step 5: Complete installation @@ -82 +120,0 @@ Choose which repositories to allow the app to access: -After selecting repositories, complete the GitHub app installation. You'll be redirected back to the AWS DevOps Agent console, where GitHub will appear as registered at the account level. @@ -105,4 +142,0 @@ You can connect different sets of repositories to different Agent Spaces based o -### Associating AWS resources with project deployments - -See [Associating AWS resources with project deployments](./connecting-to-cicd-pipelines-associating-aws-resources-with-project-deployments.html) to associate deployments with AWS resources. This helps incident investigations correlate recent deployments with possible root causes. - @@ -123,0 +158,2 @@ The AWS DevOps Agent GitHub app: +For GitHub Enterprise Server, the GitHub App is automatically created on your instance during registration. You can manage the app's repository access or uninstall it through **Settings > Applications > Installed GitHub Apps**. To delete the app definition entirely, go to **Settings > Developer settings > GitHub Apps**. + @@ -126 +162 @@ The AWS DevOps Agent GitHub app: - * **Updating repository access** – To change which repositories the GitHub app can access, go to your GitHub account or organization settings, navigate to installed GitHub apps, and modify the AWS DevOps Agent app configuration. + * **Updating repository access** – To change which repositories the GitHub app can access, go to your GitHub account or organization settings (or your GitHub Enterprise Server instance settings), navigate to installed GitHub apps, and modify the AWS DevOps Agent app configuration. @@ -130 +166,5 @@ The AWS DevOps Agent GitHub app: - * **Removing GitHub connection** – To disconnect GitHub from an Agent Space, select the connection in the Pipeline section and click **Remove**. To uninstall the GitHub app completely, uninstall it from your GitHub account or organization settings. + * **Removing GitHub connection** – To disconnect GitHub from an Agent Space, select the connection in the Pipeline section and click **Remove**. To uninstall the GitHub app completely, uninstall it from your GitHub account or organization settings. For GitHub Enterprise Server, because the GitHub App is created directly on your instance during registration, you can optionally clean up the app entirely by performing both of the following: + + * **Uninstall the app** – Go to **Settings > Applications > Installed GitHub Apps**, click **Configure** on the app, then uninstall it. + + * **Delete the app** – Go to **Settings > Developer settings > GitHub Apps**, select the app, go to the **Advanced** tab, and choose **Delete GitHub App**. **Warning:** Deleting the GitHub App is permanent and cannot be undone. If you delete it, you will need to re-register GitHub Enterprise Server from the beginning in the AWS DevOps Agent console to create a new app.