Skip to content

Commit

Permalink
Change Dedicated infra update instructions to reference s3 url (#3981)
Browse files Browse the repository at this point in the history
* Change instructions to s3 url

* fix grammar
  • Loading branch information
lucasvaltl authored Sep 20, 2023
1 parent 8fcecb9 commit 8def11a
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ See [Deployment and Updates](/docs/gitpod-dedicated/background/deployment-update

## Gitpod Dedicated Infrastructure Update Process

1. Receive the updated CloudFormation templates from your Gitpod Account Manager. Note that you may receive either one
1. Receive the updated CloudFormation templates from your Gitpod Account Manager in the form of S3 URLs. Note that you may receive either one
or two templates depending on the updates required.
2. If you receive two templates, apply them in this order:
2. If you receive two S3 URLs for two separate CloudFormation templates, apply them in this order:
- **First**, update the stack for the infrastructure creation role (`gitpod-role`).
- Important: When updating this stack, **do not select any role** under permissions.
- **Then**, update the stack for the Gitpod Infrastructure.
Expand All @@ -23,21 +23,21 @@ See [Deployment and Updates](/docs/gitpod-dedicated/background/deployment-update
3. If you only receive one template, follow the relevant instructions as described below.

Consult the [Infrastructure Update Changelog](/docs/gitpod-dedicated/reference/infrastructure-update-changelog) or your
Gitpod Account Manager to determine which stacks need updates and the number of templates you should apply.
Gitpod Account Manager to determine which stacks need updates and the impact of the update in terms of downtime.

## Detailed Steps

### 1. Update Infrastructure Creation Role

1. Go to the AWS CloudFormation page and select the stack for the infrastructure creation role.
2. Choose "Create change set for current stack" in the stack actions.
3. Select "Replace current template" and upload the updated CloudFormation template for the infrastructure creation
role.
3. Select "Replace current template", select Amazon S3 URL as the template source then paste the S3 url for the `gitpod-role` template into the field.
4. Follow the prompts in the AWS console UI.
5. Under permissions, **do not** select any role.
6. Acknowledge that IAM resources may be created and press "Submit".
7. Once a change set is published, verify the changes.
8. Execute the change set. Choose "Roll back all stack resources" for behavior on provisioning failure. Wait for the
> ❗️ Under permissions **do not select any role**:
> ![Update Permissions](/images/docs/gitpod-dedicated/guides/updating-gitpod-dedicated-infrastructure/permission-update-role-template.webp)
5. Acknowledge that IAM resources may be created and press "Submit".
6. Once a change set is published, verify the changes.
7. Execute the change set. Choose "Roll back all stack resources" for behavior on provisioning failure. Wait for the
update to complete, and the status will change to `UPDATE_COMPLETE`.

### 2. Update Gitpod Infrastructure
Expand Down Expand Up @@ -68,8 +68,7 @@ Gitpod Account Manager to determine which stacks need updates and the number of
</div>
</details>

3. Select "Replace current template" and upload the updated CloudFormation template for Gitpod Infrastructure.

3. Select "Replace current template", select Amazon S3 URL as the template source then paste the S3 url for the `gitpod-role` template into the field.
<details>

<summary class="text-body mt-3 text-p-medium ml-6"> Screenshot </summary>
Expand All @@ -83,10 +82,10 @@ Gitpod Account Manager to determine which stacks need updates and the number of

4. Follow along in the process as described in the AWS console UI

> ❗️ Under permissions ensure you select `GitpodSetupAndInitialEKSUserAdmin` as the stack execution role. This role was
> ❗️ Under permissions ensure you select **`GitpodSetupAndInitialEKSUserAdmin`** as the stack execution role. This role was
> created by applying a CloudFormation template supplied by Gitpod in the initial installation process.
> See [Getting Started](/docs/gitpod-dedicated/guides/getting-started) for more information.
> ![Update Permissions](/images/docs/gitpod-dedicated/guides/updating-gitpod-dedicated-infrastructure/permissions-update.webp)
> ![Update Permissions](/images/docs/gitpod-dedicated/guides/updating-gitpod-dedicated-infrastructure/permissions-update-gitpod-template.webp)
6. Acknowledge that IAM resources may be created and press "Submit".

Expand Down
Binary file not shown.
Binary file not shown.

0 comments on commit 8def11a

Please sign in to comment.