feat: adds a complete set of toolbox tasks #6
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,107 @@ | ||
| # See more information in docs/toolbox.md | ||
| version: "3" | ||
| vars: | ||
| VERSION: | ||
| sh: git rev-parse --short HEAD | ||
| TOOLBOX_NAME: '{{.TOOLBOX_NAME | default "toolbox"}}' | ||
| LATEST_IMAGE_TAG: "{{.TOOLBOX_NAME}}:latest" | ||
| VERSION_IMAGE_TAG: "{{.TOOLBOX_NAME}}:{{.VERSION}}" | ||
| REGISTRY_LATEST_URL: "{{.REGISTRY_URL_BASE}}/{{.LATEST_IMAGE_TAG}}" | ||
| REGISTRY_VERSION_URL: "{{.REGISTRY_URL_BASE}}/{{.VERSION_IMAGE_TAG}}" | ||
| CONTAINERFILE_PATH: '{{.CONTAINERFILE_PATH | default "./Containerfile"}}' | ||
| AWS_REGION: '{{.AWS_REGION | default "us-east-1"}}' | ||
|
|
||
| tasks: | ||
| auth: | ||
| desc: Authenticate to AWS ECR | ||
| internal: true | ||
| requires: | ||
| vars: | ||
| - AWS_REGION | ||
| - REGISTRY_URL_BASE | ||
| cmds: | ||
| - aws ecr get-login-password --region {{.AWS_REGION}} | docker login --username AWS --password-stdin {{.REGISTRY_URL_BASE}} | ||
|
|
||
| clean: | ||
| desc: Cleans all toolbox images off of the local machine | ||
| prompt: Are you sure you want to clean all {{.TOOLBOX_NAME}} toolbox images off of the local machine? | ||
| requires: | ||
| vars: | ||
| - TOOLBOX_NAME | ||
| cmds: | ||
| - docker rmi $(docker images --format '{{ "{{" }}.Repository{{ "}}" }}:{{ "{{" }}.Tag{{ "}}" }}' | grep '{{.TOOLBOX_NAME}}') | ||
|
|
||
| build: | ||
| desc: Build and tag our toolbox image | ||
| requires: | ||
| vars: | ||
| - TOOLBOX_NAME | ||
| - CONTAINERFILE_PATH | ||
| - REGISTRY_URL_BASE | ||
| cmds: | ||
| - | | ||
| docker build --tag {{.LATEST_IMAGE_TAG}} \ | ||
| --tag {{.VERSION_IMAGE_TAG}} \ | ||
| --tag {{.REGISTRY_LATEST_URL}} \ | ||
| --tag {{.REGISTRY_VERSION_URL}} \ | ||
| -f {{.CONTAINERFILE_PATH}} . | ||
| - echo "Done building and tagging toolbox 💯 Tagged as {{.VERSION_IMAGE_TAG}} + {{.LATEST_IMAGE_TAG}}" | ||
|
|
||
| pull: | ||
| desc: Pull our toolbox image from registry | ||
| deps: | ||
| - auth | ||
| requires: | ||
| vars: | ||
| - REGISTRY_URL_BASE | ||
| - REGISTRY_LATEST_URL | ||
| cmds: | ||
| - docker pull {{.REGISTRY_LATEST_URL}} | ||
| - docker tag {{.REGISTRY_LATEST_URL}} {{.LATEST_IMAGE_TAG}} | ||
|
|
||
| publish: | ||
| desc: Publish our toolbox image to the registry | ||
| deps: | ||
| - auth | ||
| requires: | ||
| vars: | ||
| - REGISTRY_URL_BASE | ||
|
There was a problem hiding this comment. Same here, one of them can be required if I get this right. There was a problem hiding this comment. Let's continue this conversation in the above thread 👍 |
||
| - REGISTRY_LATEST_URL | ||
| cmds: | ||
| - docker push {{.REGISTRY_LATEST_URL}} | ||
| - docker push {{.REGISTRY_VERSION_URL}} | ||
|
|
||
| install: | ||
| desc: Execute the toolbox wrapper script from geodesic, installing a toolbox start script onto the local host | ||
| summary: | | ||
| This executes the `init | bash` geodesic command, which pipes a bash script to the host machine which installs a | ||
| helper script onto the host. The helper script is used to easily start / attach the toolbox image as a container | ||
| and properly pass all of the relevant flags to docker (i.e. exposes a port, mounts $HOME to /localhost, etc.) | ||
| requires: | ||
| vars: | ||
| - TOOLBOX_NAME | ||
| - REGISTRY_LATEST_URL | ||
| cmds: | ||
| - docker run --rm {{.REGISTRY_LATEST_URL}} init | bash -s {{.TOOLBOX_NAME}} | ||
|
There was a problem hiding this comment. better but ideally there could be a link to the script itself so we can review that before running it on our machines 😁 There was a problem hiding this comment. @kevcube good idea, done 👍 |
||
|
|
||
| run: | ||
| desc: Run our toolbox image from the helper script installed on the host. | ||
| deps: | ||
| - install | ||
| requires: | ||
| vars: | ||
| - TOOLBOX_NAME | ||
| cmds: | ||
| - "{{.TOOLBOX_NAME}}" | ||
|
|
||
| run:build: | ||
| desc: Build, install, and run the toolbox image | ||
| cmds: | ||
| - task: build | ||
| - task: run | ||
|
|
||
| run:pull: | ||
| desc: Pull, install, and run the toolbox image | ||
| cmds: | ||
| - task: pull | ||
| - task: run | ||
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.
Why is it required?
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.
@gberenice
REGISTRY_URL_BASEdoes not have a default and without a value, theREGISTRY_*vars will be broken. I added requiring here to ensure that we're passing a value from.env.taskit. Maybe there is a better way to do this?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.
Hm, probably not. I don't see a way to add a check to the global
varssection. LATEST_IMAGE_TAG has a default, so probably just REGISTRY_URL_BASE needs to be required. But I don't feel strong about this, and I get why we'd want to check them all.