Add docker dev set up instruction #3444

abbyhu2000 · 2023-02-17T19:01:17Z

Description

For the college contributor initiative, add a folder under the root docs folder that includes instruction on using docker to set up the development environment for docker.

Issues Resolved

[List any issues this PR will resolve]

Check List

codecov-commenter · 2023-02-18T01:15:02Z

Codecov Report

Merging #3444 (9ccf206) into main (844059c) will decrease coverage by 0.06%.
The diff coverage is n/a.

❗ Current head 9ccf206 differs from pull request most recent head 2d954da. Consider uploading reports for the commit 2d954da to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main    #3444      +/-   ##
==========================================
- Coverage   66.46%   66.40%   -0.06%     
==========================================
  Files        3205     3205              
  Lines       61563    61563              
  Branches     9497     9497              
==========================================
- Hits        40915    40881      -34     
- Misses      18377    18405      +28     
- Partials     2271     2277       +6

Flag	Coverage Δ
Linux	`66.40% <ø> (ø)`
Windows	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

joshuarrrr

Lots of little copyediting suggestions.

I didn't look too deeply at the docker-compose file.

The biggest missing piece is just an intro to the setup guide that helps a user understand what they'll end up with by completing the guide, and enough info to determine if it's useful for them (it assumes Docker, VS Code, etc.)

docs/docker-dev/docker-dev-setup-manual.md

docs/docker-dev/entrypoint.sh

docs/docker-dev/docker-compose.yml

dev-tools/install-docker-dev.sh

docs/docker-dev/docker-dev-setup-manual.md

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

kavilla

Good iteration for me. Thanks!

Probably can create issues to create an OSD docker account. Then work on passing by versioning. Adding warnings or pitfalls with using this method.

kavilla · 2023-03-10T23:17:03Z

@abbyhu2000 or anyone who is merging this in. I would make sure the commit when it gets merged a single cohesive commit instead of an automatic squashing for commits.

abbyhu2000 · 2023-03-10T23:23:01Z

Good iteration for me. Thanks!

Probably can create issues to create an OSD docker account. Then work on passing by versioning. Adding warnings or pitfalls with using this method.

Thanks @kavilla and created the issue for creating OSD docker account: #3595

* docker dev set up folder Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add curl commands to set up and copy the files Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * changelog changes Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * addressing comments Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker link to the developer guide Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Add notes on docker desktop Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * publish the docker image to docker hub Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker exec as another option Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> (cherry picked from commit 7b18e06) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* docker dev set up folder Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add curl commands to set up and copy the files Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * changelog changes Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * addressing comments Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker link to the developer guide Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Add notes on docker desktop Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * publish the docker image to docker hub Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker exec as another option Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> (cherry picked from commit 7b18e06) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docker dev set up folder Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add curl commands to set up and copy the files Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * changelog changes Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * addressing comments Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker link to the developer guide Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Add notes on docker desktop Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * publish the docker image to docker hub Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * add docker exec as another option Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Signed-off-by: David Sinclair <david@sinclair.tech>

abbyhu2000 requested a review from a team as a code owner February 17, 2023 19:01

abbyhu2000 self-assigned this Feb 17, 2023

abbyhu2000 added docs Improvements or additions to documentation and removed docs Improvements or additions to documentation labels Feb 17, 2023

abbyhu2000 force-pushed the docker-dev-setup-instruction branch from f194730 to 846e04a Compare February 17, 2023 19:05

abbyhu2000 added the docs Improvements or additions to documentation label Feb 17, 2023

abbyhu2000 force-pushed the docker-dev-setup-instruction branch 2 times, most recently from 182d342 to 12b9451 Compare February 18, 2023 00:26

joshuarrrr reviewed Feb 24, 2023

View reviewed changes

abbyhu2000 force-pushed the docker-dev-setup-instruction branch 2 times, most recently from ebacd34 to cfd8075 Compare March 6, 2023 22:06

ananzh previously approved these changes Mar 6, 2023

View reviewed changes

abbyhu2000 dismissed ananzh’s stale review via 6a17485 March 7, 2023 00:12

abbyhu2000 force-pushed the docker-dev-setup-instruction branch 2 times, most recently from 6a17485 to c770649 Compare March 7, 2023 18:44

ashwin-pc assigned abbyhu2000 and unassigned abbyhu2000 Mar 7, 2023

kavilla reviewed Mar 8, 2023

View reviewed changes

docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved

kavilla reviewed Mar 8, 2023

View reviewed changes

docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved

abbyhu2000 added 6 commits March 9, 2023 18:31

docker dev set up folder

dc2b851

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

add curl commands to set up and copy the files

8657aab

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

changelog changes

80a2714

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

addressing comments

4e1e5d2

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

add docker link to the developer guide

8d79667

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Add notes on docker desktop

c4b6dbe

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 force-pushed the docker-dev-setup-instruction branch 3 times, most recently from c483bfa to 875b965 Compare March 9, 2023 19:27

publish the docker image to docker hub

2d954da

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 force-pushed the docker-dev-setup-instruction branch from 875b965 to 2d954da Compare March 9, 2023 19:29

add docker exec as another option

d97ec7a

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

kavilla approved these changes Mar 10, 2023

View reviewed changes

abbyhu2000 mentioned this pull request Mar 10, 2023

Create OSD docker account #3595

Open

ananzh approved these changes Mar 10, 2023

View reviewed changes

ananzh merged commit 7b18e06 into opensearch-project:main Mar 10, 2023

abbyhu2000 added backport 2.x v2.7.0 labels Mar 10, 2023

opensearch-trigger-bot bot mentioned this pull request Mar 10, 2023

[Backport 2.x] Add docker dev set up instruction #3597

Merged

This was referenced Apr 13, 2023

Docker dev environment support #2196

Closed

[Feature] Easier developer environment setup #3065

Closed

abbyhu2000 deleted the docker-dev-setup-instruction branch June 30, 2023 17:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docker dev set up instruction #3444

Add docker dev set up instruction #3444

abbyhu2000 commented Feb 17, 2023

codecov-commenter commented Feb 18, 2023 •

edited

Loading

joshuarrrr left a comment

kavilla left a comment

kavilla commented Mar 10, 2023

abbyhu2000 commented Mar 10, 2023

Add docker dev set up instruction #3444

Add docker dev set up instruction #3444

Conversation

abbyhu2000 commented Feb 17, 2023

Description

Issues Resolved

Check List

codecov-commenter commented Feb 18, 2023 • edited Loading

Codecov Report

joshuarrrr left a comment

Choose a reason for hiding this comment

kavilla left a comment

Choose a reason for hiding this comment

kavilla commented Mar 10, 2023

abbyhu2000 commented Mar 10, 2023

codecov-commenter commented Feb 18, 2023 •

edited

Loading