Skip to content

DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image #783

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

Merged
merged 5 commits into from
Dec 13, 2024

Conversation

jvincent-mongodb
Copy link
Collaborator

Self-Review Checklist

  • Check that the submodule pulled in the right changes (if applicable).
  • Define taxonomy values at top of page.
  • Add genre facets (tutorial or reference), as in this example PR.
  • Add programmingLanguage (if necessary).
  • Add meta keywords (if necessary).
  • Resolve any new warnings or errors in the build.
  • Proofread for spelling and grammatical errors.
  • Check staging for rendering issues.
  • Confirm links are working.

Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for docs-atlas-cli ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/docs-atlas-cli/deploys/67588b8576be0651d6f574f6
😎 Deploy Preview https://deploy-preview-783--docs-atlas-cli.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

.. code-block:: yaml

local_dev_atlas:
image: mongodb/mongodb-atlas-local:latest
Copy link
Collaborator

Choose a reason for hiding this comment

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

we are missing

Suggested change
image: mongodb/mongodb-atlas-local:latest
image: mongodb/mongodb-atlas-local:latest
hostname: local_dev_atlas


.. code-block:: yaml

local_dev_atlas:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
local_dev_atlas:
services:
local_dev_atlas:

- MONGODB_INITDB_ROOT_PASSWORD=pass
volumes:
- data:/data/db
- config:/data/configdb
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- config:/data/configdb
- config:/data/configdb
volumes:
- data:
- config:


.. code-block:: yaml

self_built_atlas_implementation:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
self_built_atlas_implementation:
services:
self_built_atlas_implementation:

Copy link
Collaborator

@erabil-mdb erabil-mdb left a comment

Choose a reason for hiding this comment

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

LGTM + nits

the `mongodb-atlas-local <https://hub.docker.com/r/mongodb/mongodb-atlas-local>`__ image.

1. Remove any existing ``command`` from your ``docker-compose.yaml`` file. Because
the ``comand`` in a Docker Compose definition overrides the ``ENTRYPOINT``
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
the ``comand`` in a Docker Compose definition overrides the ``ENTRYPOINT``
the ``command`` in a Docker Compose definition overrides the ``ENTRYPOINT``

defined in the ``mongodb-atlas-local`` image, you must remove any existing
``command`` for the ``mongodb-atlas-local`` image to run as designed.

2. There is no need to define a health check for the Atlas deployment, as this
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
2. There is no need to define a health check for the Atlas deployment, as this
2. There is no need to define a health check for the |service| deployment, as this


.. _convert-to-local-dev:

Convert Official Image to an Atlas Local Dev Implementation
Copy link
Collaborator

@fmenezes fmenezes Dec 10, 2024

Choose a reason for hiding this comment

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

nit: I think the feature is being called "Local Atlas Deployment" in https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/

Suggested change
Convert Official Image to an Atlas Local Dev Implementation
Convert Official Image to a Local Atlas Deployment

@@ -432,3 +439,55 @@ directory:
sudo dpkg -i mongosh.deb
mongosh --version
- run: mongosh 'mongodb://localhost/?directConnection=true' --eval 'show dbs'


.. _convert-to-local-dev:
Copy link
Collaborator

@fmenezes fmenezes Dec 10, 2024

Choose a reason for hiding this comment

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

nit: It would be nice to link to the docker hub links, the mongo:8.0 links to https://hub.docker.com/_/mongo and our image to https://hub.docker.com/r/mongodb/mongodb-atlas-local


services:
local_dev_atlas:
image: mongodb/mongodb-atlas-local:latest
Copy link
Collaborator

Choose a reason for hiding this comment

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

nitpick: you can use same mongodb version here as well

Suggested change
image: mongodb/mongodb-atlas-local:latest
image: mongodb/mongodb-atlas-local:8.0

@jvincent-mongodb jvincent-mongodb merged commit 464319a into mongodb:master Dec 13, 2024
4 checks passed
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit to jvincent-mongodb/docs-atlas-cli that referenced this pull request Dec 13, 2024
…l image to local dev image (mongodb#783)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
@jvincent-mongodb
Copy link
Collaborator Author

💔 Some backports could not be created

Status Branch Result
v1.32
v1.31
v1.30
v1.29
v1.28 Conflict resolution was aborted by the user
v1.27 Conflict resolution was aborted by the user
v1.26 Conflict resolution was aborted by the user
v1.25
v1.24
v1.23
v1.22
v1.21
v1.20
v1.19
v1.18
v1.17
v1.16
v1.15
v1.14
v1.13 Conflict resolution was aborted by the user
v1.12 Conflict resolution was aborted by the user

Manual backport

To create the backport manually run:

backport --pr 783

Questions ?

Please refer to the Backport tool documentation

jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#787)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#788)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#789)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#790)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#792)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#793)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#795)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#796)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#798)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#799)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#801)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#802)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#797)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#800)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
jvincent-mongodb added a commit that referenced this pull request Dec 16, 2024
…l image to local dev image (#783) (#791)

* DOCSP-45301 -- Add checklist and examples for converting from official image to local dev image

* DOCSP-45301 -- edit example yaml

* DOCSP-45301 -- external review revisions

* DOCSP-45301 -- copy review revisions

* DOCSP-45301 -- external review revisions

(cherry picked from commit 464319a)
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.

3 participants