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

[Docs] Update docker container doc #2573

Merged
merged 2 commits into from
Sep 18, 2023
Merged

[Docs] Update docker container doc #2573

merged 2 commits into from
Sep 18, 2023

Conversation

cblmemo
Copy link
Collaborator

@cblmemo cblmemo commented Sep 18, 2023

This PR updates the docker container doc by:

  • give a concrete example of SKYPILOT_DOCKER_SERVER;
  • suggest passing secrets

Tested (run the relevant ones):

  • Code formatting: bash format.sh
  • Any manual or new tests for this PR (please specify below)
  • All smoke tests: pytest tests/test_smoke.py
  • Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
  • Backward compatibility tests: bash tests/backward_comaptibility_tests.sh


.. code-block:: yaml

# private_docker.yaml
# ecr_private_docker.yaml
resources:
image_id: docker:<your-private-image>:<tag>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're giving a concrete example, might as well also update this to something concrete:

Suggested change
image_id: docker:<your-private-image>:<tag>
image_id: docker:<your-user-id>.dkr.ecr.us-east-1.amazonaws.com/your-private-image:latest

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh actually we only require users to specify your-private-image in the image_id section... See here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the confusion. Maybe we could support both? Let me raise an PR to fix it

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in #2574

@cblmemo cblmemo merged commit bc4acc8 into master Sep 18, 2023
18 checks passed
@cblmemo cblmemo deleted the upd-docker-doc branch September 18, 2023 17:42
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.

2 participants