-
Notifications
You must be signed in to change notification settings - Fork 503
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
Comments
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.) |
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 |
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. |
Beginning work on RPM/Yum refactor. |
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. |
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. |
Finally got some time to circle back around to this. Finishing up the steps for RPM/Yum install. |
Next topic to cover: Docker install of dashboards |
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. |
Switching over to migration documentation now. Parking this ticket until I have cycles to pick it back up and review Helm, Ansible, and K8s. |
Putting this back in progress for the morning while I work on distilling a quickstart guide from the new Docker material. |
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. |
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. |
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
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"
The text was updated successfully, but these errors were encountered: