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

Add docker dev set up instruction #3444

Merged

Conversation

abbyhu2000
Copy link
Member

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

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@abbyhu2000 abbyhu2000 requested a review from a team as a code owner February 17, 2023 19:01
@abbyhu2000 abbyhu2000 self-assigned this Feb 17, 2023
@abbyhu2000 abbyhu2000 added docs Improvements or additions to documentation and removed docs Improvements or additions to documentation labels Feb 17, 2023
@abbyhu2000 abbyhu2000 force-pushed the docker-dev-setup-instruction branch from f194730 to 846e04a Compare February 17, 2023 19:05
@abbyhu2000 abbyhu2000 added the docs Improvements or additions to documentation label Feb 17, 2023
@abbyhu2000 abbyhu2000 force-pushed the docker-dev-setup-instruction branch 2 times, most recently from 182d342 to 12b9451 Compare February 18, 2023 00:26
@codecov-commenter
Copy link

codecov-commenter commented Feb 18, 2023

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.

Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

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 Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Outdated Show resolved Hide resolved
docs/docker-dev/entrypoint.sh Outdated Show resolved Hide resolved
docs/docker-dev/docker-compose.yml Outdated Show resolved Hide resolved
dev-tools/install-docker-dev.sh Outdated Show resolved Hide resolved
docs/docker-dev/docker-dev-setup-manual.md Show resolved Hide resolved
@abbyhu2000 abbyhu2000 force-pushed the docker-dev-setup-instruction branch 2 times, most recently from ebacd34 to cfd8075 Compare March 6, 2023 22:06
ananzh
ananzh previously approved these changes Mar 6, 2023
@abbyhu2000 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 ashwin-pc assigned abbyhu2000 and unassigned abbyhu2000 Mar 7, 2023
@abbyhu2000 abbyhu2000 force-pushed the docker-dev-setup-instruction branch 3 times, most recently from c483bfa to 875b965 Compare March 9, 2023 19:27
@abbyhu2000 abbyhu2000 force-pushed the docker-dev-setup-instruction branch from 875b965 to 2d954da Compare March 9, 2023 19:29
Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

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
Copy link
Member

kavilla commented Mar 10, 2023

@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
Copy link
Member Author

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

@ananzh ananzh merged commit 7b18e06 into opensearch-project:main Mar 10, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 10, 2023
* docker dev set up folder

Signed-off-by: abbyhu2000 <[email protected]>

* add curl commands to set up and copy the files

Signed-off-by: abbyhu2000 <[email protected]>

* changelog changes

Signed-off-by: abbyhu2000 <[email protected]>

* addressing comments

Signed-off-by: abbyhu2000 <[email protected]>

* add docker link to the developer guide

Signed-off-by: abbyhu2000 <[email protected]>

* Add notes on docker desktop

Signed-off-by: abbyhu2000 <[email protected]>

* publish the docker image to docker hub

Signed-off-by: abbyhu2000 <[email protected]>

* add docker exec as another option

Signed-off-by: abbyhu2000 <[email protected]>

---------

Signed-off-by: abbyhu2000 <[email protected]>
(cherry picked from commit 7b18e06)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
abbyhu2000 pushed a commit that referenced this pull request Mar 13, 2023
* docker dev set up folder

Signed-off-by: abbyhu2000 <[email protected]>

* add curl commands to set up and copy the files

Signed-off-by: abbyhu2000 <[email protected]>

* changelog changes

Signed-off-by: abbyhu2000 <[email protected]>

* addressing comments

Signed-off-by: abbyhu2000 <[email protected]>

* add docker link to the developer guide

Signed-off-by: abbyhu2000 <[email protected]>

* Add notes on docker desktop

Signed-off-by: abbyhu2000 <[email protected]>

* publish the docker image to docker hub

Signed-off-by: abbyhu2000 <[email protected]>

* add docker exec as another option

Signed-off-by: abbyhu2000 <[email protected]>

---------

Signed-off-by: abbyhu2000 <[email protected]>
(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>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
* docker dev set up folder

Signed-off-by: abbyhu2000 <[email protected]>

* add curl commands to set up and copy the files

Signed-off-by: abbyhu2000 <[email protected]>

* changelog changes

Signed-off-by: abbyhu2000 <[email protected]>

* addressing comments

Signed-off-by: abbyhu2000 <[email protected]>

* add docker link to the developer guide

Signed-off-by: abbyhu2000 <[email protected]>

* Add notes on docker desktop

Signed-off-by: abbyhu2000 <[email protected]>

* publish the docker image to docker hub

Signed-off-by: abbyhu2000 <[email protected]>

* add docker exec as another option

Signed-off-by: abbyhu2000 <[email protected]>

---------

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: David Sinclair <[email protected]>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
* docker dev set up folder

Signed-off-by: abbyhu2000 <[email protected]>

* add curl commands to set up and copy the files

Signed-off-by: abbyhu2000 <[email protected]>

* changelog changes

Signed-off-by: abbyhu2000 <[email protected]>

* addressing comments

Signed-off-by: abbyhu2000 <[email protected]>

* add docker link to the developer guide

Signed-off-by: abbyhu2000 <[email protected]>

* Add notes on docker desktop

Signed-off-by: abbyhu2000 <[email protected]>

* publish the docker image to docker hub

Signed-off-by: abbyhu2000 <[email protected]>

* add docker exec as another option

Signed-off-by: abbyhu2000 <[email protected]>

---------

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: David Sinclair <[email protected]>
@abbyhu2000 abbyhu2000 deleted the docker-dev-setup-instruction branch June 30, 2023 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x docs Improvements or additions to documentation v2.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants