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

[DOC-META] Installation guide refactor + recommended config (Tarball, Docker, Yum, RPM) #789

Closed
10 tasks done
JeffHuss opened this issue Jul 11, 2022 · 14 comments
Closed
10 tasks done
Assignees
Labels
Closed - Complete Issue: Work is done and associated PRs closed configuration installation Documentation for installing OpenSearch across various platforms Usability v-All This issue is valid for all versions through 1.3
Milestone

Comments

@JeffHuss
Copy link

JeffHuss commented Jul 11, 2022

What do you want to do?

Current documentation does not clearly provide all of the steps required for standing up OpenSearch and OpenSearch Dashboards, whether the installation is performed using Docker or manually by inflating and configuring the tarball archive.

This will also require moving things within the docs so they make more sense in their given context. Sub-tasks will be defined as work progresses.

Milestone 1 Tasks - OpenSearch Core

  • Review tar archive install steps
  • Stand up OpenSearch node on a host from tar.gz
  • Submit PR with enhancements to tar archive install (Merged)
  • Review Docker install steps
  • Stand up OpenSearch node on a host using Docker
  • Submit PR with enhancements to Docker install (Merged)
  • Review RPM/Yum install steps
  • Stand up OpenSearch node on a host using RPM/Yum
  • Submit PR with enhancements to RPM/Yum install (Merged)
  • Review existing materials and create a quick start guide (in review)

Milestone 2 Tasks - OpenSearch Dashboards

-- Removing the tasks here since Dashboards content is handled by another writer now --

Linked PRs:

Removing this section - PRs that are relevant are tagged with "Related to #789"

@JeffHuss JeffHuss added enhancement New feature or request untriaged labels Jul 11, 2022
@JeffHuss JeffHuss self-assigned this Jul 11, 2022
@JeffHuss JeffHuss added xx-documentation Improvements or additions to documentation v2.1.0 2 - In progress Issue/PR: The issue or PR is in progress. backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x and removed untriaged labels Jul 11, 2022
@JeffHuss JeffHuss added this to the 2022-Q3 milestone Jul 11, 2022
@hdhalter hdhalter changed the title [META] Validate and enhance OpenSearch installation docs (Install using Docker and from Tarball) [DOC-META] Validate and enhance OpenSearch installation docs (Install using Docker and from Tarball) Jul 13, 2022
@JeffHuss JeffHuss added v-All This issue is valid for all versions through 1.3 and removed v2.1.0 backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x labels Jul 13, 2022
@JeffHuss JeffHuss changed the title [DOC-META] Validate and enhance OpenSearch installation docs (Install using Docker and from Tarball) [DOC-META] Review, validate and enhance OpenSearch and OpenSearch-Dashboards installation docs (Docker and tarball) Jul 13, 2022
@JeffHuss JeffHuss added the installation Documentation for installing OpenSearch across various platforms label Jul 19, 2022
@Naarcha-AWS Naarcha-AWS changed the title [DOC-META] Review, validate and enhance OpenSearch and OpenSearch-Dashboards installation docs (Docker and tarball) [DOC-META] Installation docs (Docker and tarball) Jul 21, 2022
@JeffHuss
Copy link
Author

JeffHuss commented Aug 4, 2022

Making great progress on the tarball installation method. I'm currently formatting the steps in markdown and should have a PR up soon. Steps are all validated by technical resources. I'm also looking to include a brief blurb in the overview to describe basic assumed competencies (like familiarity with Linux CLI, etc.)

@JeffHuss
Copy link
Author

JeffHuss commented Aug 5, 2022

As I'm peeling back the many layers to this onion I continue to uncover additional things that need to be fixed up. For example, we have documentation in the Tarball installation guide about installing the Performance Analyzer plugin. It looks like this may have been included here because a manual configuration is required for tarball installations of OpenSearch. This is going to take a little bit of research. I'm going to keep working on it this afternoon but will have to shift gears to a 2.2 deliverable next Monday. The scope for that hasn't been defined yet (I'm meeting with the developer in the afternoon on Monday) so I'm not sure how many hours of effort that will take.

@JeffHuss
Copy link
Author

JeffHuss commented Aug 8, 2022

During a sync today with Nate A. and Himanshu S. there we some good call-outs. I made some changes and pushed them to the draft PR based on feedback.

Himanshu pointed out that the landing page for the security plugin configuration (https://opensearch.org/docs/latest/security-plugin/configuration/index/) doesn't make it clear which files are being modified. However, I did find the steps listed in https://opensearch.org/docs/latest/security-plugin/configuration/yaml/ so I explicitly linked to that page. In the future I think we might want to break it out into its own page, but that would make sense as a natural step as our docs evolve and begin to incorporate more available YAML settings.

@JeffHuss JeffHuss changed the title [DOC-META] Installation docs (Docker and tarball) [DOC-META] Installation with Quickstart (Tarball, Docker, Yum, RPM) Aug 25, 2022
@JeffHuss JeffHuss changed the title [DOC-META] Installation with Quickstart (Tarball, Docker, Yum, RPM) [DOC-META] Installation guide refactor + recommended config (Tarball, Docker, Yum, RPM) Aug 25, 2022
@JeffHuss
Copy link
Author

JeffHuss commented Aug 25, 2022

Beginning work on RPM/Yum refactor.

@hdhalter hdhalter removed xx-documentation Improvements or additions to documentation enhancement New feature or request labels Aug 29, 2022
@JeffHuss
Copy link
Author

Tarball refactor is completed and published. RPM/Yum next because of the significant overlap and reduced editorial review burden. Docker will come after that since it will be the ugly duckling of the bunch, with less parity to other guides and additional assumed skillsets.

@JeffHuss
Copy link
Author

RPM/Yum installation keep getting pushed back due to other priorities...will try to continue work this week but it looks like I'll be getting back on it next week.

@JeffHuss
Copy link
Author

Finally got some time to circle back around to this. Finishing up the steps for RPM/Yum install.

@JeffHuss
Copy link
Author

JeffHuss commented Oct 3, 2022

Next topic to cover: Docker install of dashboards

@JeffHuss
Copy link
Author

JeffHuss commented Oct 6, 2022

Update on priorities - next topic being covered is Docker install of OpenSearch (no special attention to dashboards), and then I'll be stepping away from installation for a bit to focus on migration documentation.

@JeffHuss
Copy link
Author

Switching over to migration documentation now. Parking this ticket until I have cycles to pick it back up and review Helm, Ansible, and K8s.

@JeffHuss JeffHuss removed this from the 2022-Q3 milestone Oct 21, 2022
@JeffHuss JeffHuss added 1 - Backlog Issue: The issue is unassigned or assigned but not started 2 - In progress Issue/PR: The issue or PR is in progress. and removed 2 - In progress Issue/PR: The issue or PR is in progress. 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Oct 21, 2022
@JeffHuss
Copy link
Author

Putting this back in progress for the morning while I work on distilling a quickstart guide from the new Docker material.

@JeffHuss
Copy link
Author

Quick start guide is in tech review now. Waiting on feedback regarding the depth of the guide - is more needed? Less? I might get it merged before Thanksgiving if the approvals and reviews are quick but no guarantees.

@JeffHuss JeffHuss modified the milestones: v 3.0, 2022-Q4 Nov 22, 2022
@JeffHuss JeffHuss added Closed - Complete Issue: Work is done and associated PRs closed and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Nov 23, 2022
@JeffHuss
Copy link
Author

Refactor completed for tarball, RPM/YUM, and Docker installations. Additionally, I created a quickstart guide from scratch and pushed it.

Next priority is upgrading OS, followed by migrations from other platforms or infrastructure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Complete Issue: Work is done and associated PRs closed configuration installation Documentation for installing OpenSearch across various platforms Usability v-All This issue is valid for all versions through 1.3
Projects
None yet
Development

No branches or pull requests

2 participants