crunchy-containers icon indicating copy to clipboard operation
crunchy-containers copied to clipboard

Suggestions to improve the Docker primary examples.

Open roberto-mello opened this issue 2 years ago • 0 comments

  1. The use of the $CCPROOT env var requires it be exported first, and the individual example do mention that, so I think it should just be removed.

  2. Add -e MODE to run.sh, without which run.sh fails

  3. Add exports of CCP_IMAGE_PREFIX and CCP_IMAGE_TAG where to find them, to the example, without which run.sh also fails

  4. Add the use of PGPASSWORD to the psql example, without which the user will have to review run.sh to figure out what the password is, giving the user a little extra work

I am assuming these examples are meant for beginners getting familiar, so I believe they should just work. From them the reader will then be able to extract what one needs to deploy a proper container later.

Checklist:

  • [x] Have you added an explanation of what your changes do and why you'd like them to be included?
  • [x] Have you updated or added documentation for the change, as applicable?
  • [x] Have you tested your changes on all related environments with successful results, as applicable?

Type of Changes:

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

What is the current behavior? (link to any open issues here)

Examples that don't work

What is the new behavior (if this is a feature change)?

Examples that work

Other information:

roberto-mello avatar Apr 28 '22 16:04 roberto-mello