Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestions to improve the Docker primary examples. #1434

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

roberto-mello
Copy link

  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:

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

Type of Changes:

  • 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:

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant