Add docker image production workflow to repo 🔥 #4107

ford-at-aws · 2022-12-19T19:38:19Z

This PR...

Adds the following:

Docker images for each language (11 total) + README section explaining their usage during Beta
a GitHub Actions workflow file that will kick off an automatic docker build & push process for each language when this PR is closed (or any PR with the respective label of that language, e.g. lang/python kicks of Python docker image update process)
a CDK stack file containing the current configurations (not maintained via CICD; must be run via CLI) of the ECR repositories where these Docker images are published
a Jinja template that can be re-used to update the metadata on each repository (I'm not excited about versioning it but I also want to make maintainability as easy as possible)

💣 Blast radius

This will publish Docker images to an ECR repository that is public, so there's a customer-facing aspect to this (though the images aren't currently being advertised anywhere). But this touches no existing systems or code bases.

Note on CICD configuration

This GitHub-to-ECR configuration relies on an OIDC provider token that was created using these official steps, which use automation as the role. This config is referenced in the docker-push.yml file but exists within the target AWS account (808326389482).

Note on new AWS account

This PR deploys images to an ECR repository that is housed within a brand new AWS account: 808326389482. This account was created using Isengard with owner=brmur,fprior and team=aws-sdk-code-examples. I confirmed with a few team members already but everyone should have AdministratorAccess permissions (i.e. god mode). I will eventually scope these down, but for now I'm satisfied with the facts that (a) this is a NON-prod account, (b) we don't have to worry about billing, and (c) everyone's activities in this account are being logged via CloudTrail using their role name (e.g. weathertop-fprior). So while restrictions are absent, accountability is present.

Note on testing

I haven't figured out a good way to test this yet, as it's kind of a CICD project, but that's part of a hardening epic that will be undertaken in Q1 2023.

Pre-submit checklist:

Don't forget! By submitting this pull request, you confirm that your contribution is made under the terms of the Apache 2.0 license.

The cluster isn't stabilizing. Co-authored-by: David Souther <davidsouther@gmail.com>

* Stack for batch fargate. The cluster isn't stabilizing. * updates for working version * Delete cdk.context.json * Update batch_fargate-stack.ts * Delete package-lock.json Co-authored-by: David Souther <davidsouther@gmail.com>

cpp/README.rst

lkdavies

Editorial review

lkdavies · 2023-01-03T17:29:29Z

.doc_gen/images/template.txt

+    new ecr.CfnPublicRepository(this, "{{shortname}}", {
+          repositoryName: "{{shortname}}",
+          repositoryCatalogData: {
+            UsageText:  "This image provides a pre-built for SDK for {{language}} environment and is recommended for local testing of SDK for {{language}} example code. It is not intended for production usage. For detailed and up-to-date steps on running this image, please see https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/{{shortname}}/README.md#docker-image.",


for SDK for {{language}} --> for the SDK for {{language}}
local testing of SDK for {{language}} --> local testing of the SDK for {{language}}
please see --> see

lkdavies · 2023-01-03T17:30:48Z

.doc_gen/images/template.txt

+            UsageText:  "This image provides a pre-built for SDK for {{language}} environment and is recommended for local testing of SDK for {{language}} example code. It is not intended for production usage. For detailed and up-to-date steps on running this image, please see https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/{{shortname}}/README.md#docker-image.",
+            OperatingSystems: ["Linux"],
+            Architectures: ["x86", "ARM"],
+            RepositoryDescription: "This image provides a pre-built for SDK for {{language}} environment and is recommended for local testing of SDK for {{language}} example code."


for SDK for {{language}} --> for the SDK for {{language}}
of SDK for {{language}} --> of the SDK for {{language}}

lkdavies · 2023-01-03T17:32:04Z

cpp/README.rst

+
+In the near future, this example code will be available in a container image
+hosted on [Amazon Elastic Container Registry (ECR)](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html). This image will be pre-loaded
+with all C++ examples with dependencies pre-resolved, allowing you to explore


Here, and in the other READMEs with this text, recommend the following update:

allowing you to --> so that you can

lkdavies · 2023-01-03T17:32:23Z

cpp/README.rst

  `Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_.

 Copyright and License
 =============

 All content in this repository, unless otherwise stated, is 
-Copyright � Amazon Web Services, Inc. or its affiliates. All rights reserved.
+Copyright © Amazon Web Services, Inc. or its affiliates. All rights reserved.


Was this change intentional?

lkdavies · 2023-01-03T17:33:08Z

cpp/README.rst

+===================
+
+In the near future, this example code will be available in a container image
+hosted on [Amazon Elastic Container Registry (ECR)](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html). This image will be pre-loaded


Here, and in the other READMEs with this text, recommend the following updates:

Amazon Elastic Container Registry (ECR) --> Amazon Elastic Container Registry (Amazon ECR)
will be pre-loaded --> is preloaded

lkdavies · 2023-01-03T17:37:15Z

cpp/README.rst

+undergoing active development. Refer to
+[this GitHub issue](https://github.com/awsdocs/aws-doc-sdk-examples/issues/4133)
+for more information.


Here, and in the other READMEs with this text, recommend the following last sentence update:

For more information, see this GitHub issue.

lkdavies · 2023-01-03T17:42:23Z

javav2/README.rst

+with all Java v2 examples with dependencies pre-resolved, allowing you to explore
+these examples in an isolated environment.
+
+⚠️ As of January 2023, the [SDK for Java v2 image](https://gallery.ecr.aws/aws-docs-sdk-examples/javav2) is available on ECR Public but is still


SDK for Java v2 --> SDK for Java (v2)

lkdavies · 2023-01-03T17:43:57Z

javascriptv3/example_code/README.md

+with all JavaScript v3 examples with dependencies pre-resolved, allowing you to explore
+these examples in an isolated environment.
+
+⚠️ As of January 2023, the [SDK for JavaScript v3 image](https://gallery.ecr.aws/aws-docs-sdk-examples/javascriptv3) is available on ECR Public but is still


SDK for JavaScript v3 --> SDK for JavaScript (v3)

lkdavies · 2023-01-03T17:44:13Z

gov2/README.md

+with all Golang examples with dependencies pre-resolved, allowing you to explore
+these examples in an isolated environment.
+
+⚠️ As of January 2023, the [SDK for Go v2 image](https://gallery.ecr.aws/aws-docs-sdk-examples/dotnetv3) is available on ECR Public but is still


SDK for Go v2 --> SDK for Go (v2)

lkdavies · 2023-01-03T17:44:29Z

dotnetv3/README.md

+with all .NET examples with dependencies pre-resolved, allowing you to explore
+these examples in an isolated environment.
+
+⚠️ As of January 2023, the [SDK for .NET v3 image](https://gallery.ecr.aws/aws-docs-sdk-examples/dotnetv3) is available on ECR Public but is still


SDK for .NET v3 --> SDK for .NET (v3)

Create docker-push.yml

7b617f3

github-actions bot added the type/github-settings label Dec 19, 2022

cpyle0819 assigned ford-at-aws Dec 20, 2022

ford-at-aws added 2 commits December 22, 2022 14:29

Create render-blurbs.py

6108685

Create README.md

2d631d8

github-actions bot removed the type/github-settings label Dec 23, 2022

ford-at-aws added 2 commits December 23, 2022 12:48

dockerfiles galore

3fa43aa

Merge branch 'add-docker' into docker-push

041033c

github-actions bot added lang/cpp and removed type/github-settings labels Dec 23, 2022

Stack for batch fargate. (#4117)

4a68ef7

The cluster isn't stabilizing. Co-authored-by: David Souther <davidsouther@gmail.com>

github-actions bot added tool/cdk labels Dec 23, 2022

ford-at-aws changed the title ~~Create docker-push.yml~~ Add docker image production workflow to repo Dec 23, 2022

ford-at-aws and others added 5 commits December 26, 2022 14:07

fix

773a1af

Fords branch (#4118)

13aef84

* Stack for batch fargate. The cluster isn't stabilizing. * updates for working version * Delete cdk.context.json * Update batch_fargate-stack.ts * Delete package-lock.json Co-authored-by: David Souther <davidsouther@gmail.com>

a whole hot mess of stuff

8dbee2f

workflow:

e69c665

workflow

193b6c7

workflow

ed79262

DavidSouther reviewed Dec 29, 2022

View reviewed changes

cpp/README.rst Outdated Show resolved Hide resolved

ford-at-aws added 5 commits December 29, 2022 15:11

actually, no batch

9aea0f5

take out un-needed files

d829ac5

tweaks

71c4261

changed links

0532b6c

changed links

bd3c65e

ford-at-aws requested a review from beqqrry-aws December 30, 2022 11:21

ford-at-aws added 2 commits December 30, 2022 05:27

Update README.rst

6600560

Update README.rst

bbf69b1

ford-at-aws changed the title ~~Add docker image production workflow to repo~~ Add docker image production workflow to repo 🔥 Dec 30, 2022

ford-at-aws and others added 3 commits December 30, 2022 07:36

Merge branch 'main' into docker-push

b188150

issue

ad60b13

Update README.rst

d336a17

beqqrry-aws approved these changes Dec 30, 2022

View reviewed changes

details

d1b827e

beqqrry-aws merged commit cf53ec0 into main Dec 30, 2022

lkdavies reviewed Jan 3, 2023

View reviewed changes

lkdavies added the status/has-text-review label Jan 3, 2023

beqqrry-aws deleted the docker-push branch April 18, 2023 19:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docker image production workflow to repo 🔥 #4107

Add docker image production workflow to repo 🔥 #4107

ford-at-aws commented Dec 19, 2022 •

edited

Loading

lkdavies left a comment

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

lkdavies Jan 3, 2023

Add docker image production workflow to repo 🔥 #4107

Add docker image production workflow to repo 🔥 #4107

Conversation

ford-at-aws commented Dec 19, 2022 • edited Loading

This PR...

💣 Blast radius

Note on CICD configuration

Note on new AWS account

Note on testing

Pre-submit checklist:

lkdavies left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ford-at-aws commented Dec 19, 2022 •

edited

Loading