From e477f8a788bc0ed4a0b7b31c45fa44a6236d9401 Mon Sep 17 00:00:00 2001 From: Rohan Weeden Date: Wed, 11 Sep 2024 11:25:10 -0400 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 48420df..10cbff3 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,17 @@ Documentation](https://nasa.github.io/cumulus/docs/deployment/deployment-readme) for detailed information about configuring, deploying, and running Cumulus. -## Generating Releases +## Generating Releases ### Naming Schema: -The CIRRUS name schema is `vX.X.X.Y`. The X represents the [Cumulus version](https://github.com/nasa/cumulus/releases), -while the Y represents the CIRRUS version. +The CIRRUS name schema is `vX.X.X.Y`. The X represents the [Cumulus version](https://github.com/nasa/cumulus/releases), +while the Y represents the CIRRUS version. ### Backporting Features -A release branch should be created when backporting a feature, such as `release/v17.1.4.2`. -In this case, the release branch `release/v17.1.4.2` should be created from the tag `v17.1.4.1`. -You should then create a PR from your feature branch to the release branch. -Once the PR has been approved and merged, you can create a release based on the release branch. +A release branch should be created when backporting a feature, such as `release/v17.1.4.2`. +In this case, the release branch `release/v17.1.4.2` should be created from the tag `v17.1.4.1`. +You should then create a PR from your feature branch to the release branch. +Once the PR has been approved and merged, you can create a release based on the release branch. ## Prerequisites @@ -63,6 +63,21 @@ You can start an interactive Docker container session and use this to run tests $ make container-shell +### Docker-in-Docker Support + +By default the container shell will run with the docker socket +(`/var/run/docker.sock`) mounted to the host to allow commands inside the +container to talk to the host docker daemon. This might be needed if you want to +build and push docker container images to Amazon ECR for instance. + +It is highly likely that your docker socket will have restrictive permissions by +default that prevent it from being accessible within the container shell. You +can fix these permissions by running + + $ make docker-in-docker-permissions + +on your host machine before entering the container shell. + ## Organization The repository is organized into three Terraform modules: @@ -155,7 +170,7 @@ secrets files will *not* (and *should not*) be committed to git. The 3. Deploy Cumulus. If this is your first Cumulus deployment for this stack, deploy the entire Cumulus stack: - + $ make initial-deploy