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

tannerjones4075- update developer guide #385

Conversation

tannerjones4075
Copy link
Contributor

Description

This helps new contributors and users of the go client to start testing and using the go client by including the docker commands to start a docker container locally.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
@dblock dblock merged commit 02c73d7 into opensearch-project:main Oct 4, 2023
43 checks passed
Comment on lines +70 to +71
cd opensearch/.ci/opensearch
docker-compose -f docker-compose.yml up
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is also handled in the Makefile. So you don't need to change folders.

make cluster.build
make cluster.start

You can also run:

make cluster.stop
make cluster.clean

@opensearch-trigger-bot
Copy link

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-385-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 02c73d75d53f80208b81ed46c85577713993a5cc
# Push it to GitHub
git push --set-upstream origin backport/backport-385-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-385-to-2.x.

VachaShah pushed a commit to VachaShah/opensearch-go that referenced this pull request Oct 19, 2023
* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file and CHANGELOG

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Removed link from localhost:9200

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
VachaShah pushed a commit to VachaShah/opensearch-go that referenced this pull request Oct 19, 2023
* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file and CHANGELOG

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Removed link from localhost:9200

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
dblock added a commit that referenced this pull request Oct 23, 2023
* tannerjones4075- update developer guide (#385)

* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file to include docker build instructions

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updating DEVELOPER_GUIDE.md file and CHANGELOG

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Removed link from localhost:9200

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Bump github.com/aws/aws-sdk-go from 1.45.20 to 1.45.24 (#387)

* Bump github.com/aws/aws-sdk-go from 1.45.20 to 1.45.24

Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.45.20 to 1.45.24.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Commits](aws/aws-sdk-go@v1.45.20...v1.45.24)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Bump github.com/aws/aws-sdk-go-v2 from 1.21.0 to 1.21.1 (#388)

* Bump github.com/aws/aws-sdk-go-v2 from 1.21.0 to 1.21.1

Bumps [github.com/aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2) from 1.21.0 to 1.21.1.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Commits](aws/aws-sdk-go-v2@v1.21.0...v1.21.1)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Bump github.com/aws/aws-sdk-go-v2/config from 1.18.43 to 1.18.44 (#389)

* Bump github.com/aws/aws-sdk-go-v2/config from 1.18.43 to 1.18.44

Bumps [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2) from 1.18.43 to 1.18.44.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Commits](aws/aws-sdk-go-v2@config/v1.18.43...config/v1.18.44)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2/config
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Bump golang.org/x/net from 0.7.0 to 0.17.0 (#391)

* Bump golang.org/x/net from 0.7.0 to 0.17.0

Bumps [golang.org/x/net](https://github.com/golang/net) from 0.7.0 to 0.17.0.
- [Commits](golang/net@v0.7.0...v0.17.0)

---
updated-dependencies:
- dependency-name: golang.org/x/net
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Update DEVELOPER_GUID, Add Coverage + go ling to Makefile, Run CI tests on all branches (#392)

* .github: run test workflows for all branches, test against 2.9,2.10

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

* Makefile: use docker golangci-lint, run integration test on `.` folder, change coverage generation

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

* Update DEVELOPER_GUIDE

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

---------

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Updated linter version to 1.54.2 (#394)

* Updated linter version to 1.54.2

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updated CHANGELOG.md

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updated CHANGELOG.md

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updated CHANGELOG.md - moved linter update to Dependencies Bumps

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Deprecate legacy API (#390)

* deprecated legacy REST API /_template

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* deprecated legacy REST API /_template

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* removed deprecated header at the top of the doc

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* added deprecated notes to the CHANGELOG.md

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Corrected deprecation statement

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Update CHANGELOG.md

Co-authored-by: Jakob <jakob.hahn@hetzner.com>
Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>

* Updated deprecated message on api.indices.put_template.go

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Added deprecated message on api.indices.exists_template.go

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Added deprecated message on api.indices.delete_template.go

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Added deprecated message on api.indices.get_template.go

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* Updated deprecated message on api.indices.exists_template.go and added back in IndicesExistsTemplate that was delete by mistake

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>
Co-authored-by: Jakob <jakob.hahn@hetzner.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Bump github.com/aws/aws-sdk-go-v2/config from 1.18.44 to 1.19.0 (#398)

* Bump github.com/aws/aws-sdk-go-v2/config from 1.18.44 to 1.19.0

Bumps [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2) from 1.18.44 to 1.19.0.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Changelog](https://github.com/aws/aws-sdk-go-v2/blob/v1.19.0/CHANGELOG.md)
- [Commits](aws/aws-sdk-go-v2@config/v1.18.44...v1.19.0)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2/config
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Bump github.com/aws/aws-sdk-go from 1.45.24 to 1.45.26 (#397)

* Bump github.com/aws/aws-sdk-go from 1.45.24 to 1.45.26

Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.45.24 to 1.45.26.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Commits](aws/aws-sdk-go@v1.45.24...v1.45.26)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update changelog

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

* Bump client version to 2.4.0

Signed-off-by: Vacha Shah <vachshah@amazon.com>

---------

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>
Signed-off-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>
Co-authored-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jakob <jakob.hahn@hetzner.com>
Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants