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 update on how to add resolvers for PG and ES gateways #4502

Merged
merged 4 commits into from
Dec 23, 2020

Conversation

kalroy
Copy link
Collaborator

@kalroy kalroy commented Dec 21, 2020

Signed-off-by: Kallol Roy karoy@progress.com

🔩 Description: What code changed, and why?

The PR here #4486 allows automate to now resolve the Postgres cluster and Elasticsearch nodes using resolvers. The resolvers can be set in the config.toml by the users.

The changes document how to configure resolvers in case of external PG or ES.

⛓️ Related Resources

Updated install.md file to add sections:

  1. ADDING RESOLVERS FOR ELASTICSEARCH
  2. ADDING RESOLVERS FOR POSTGRESQL DATABASE

👍 Definition of Done

The document should have the sections mentioned above with the details of the configuration.

👟 How to Build and Test the Change

  1. Pull the code
  2. make serve
  3. The updated document should be shown in http://localhost:1313/automate/install/

✅ Checklist

📷 Screenshots, if applicable

@kalroy kalroy requested a review from a team as a code owner December 21, 2020 16:57
@netlify
Copy link

netlify bot commented Dec 21, 2020

✔️ Deploy preview for chef-automate ready!

🔨 Explore the source changes: 9ff1f4e

🔍 Inspect the deploy logs: https://app.netlify.com/sites/chef-automate/deploys/5fe282dc0954cb00088d8523

😎 Browse the preview: https://deploy-preview-4502--chef-automate.netlify.app

@kalroy kalroy self-assigned this Dec 22, 2020
@kalroy kalroy added documentation Anything related to the Automate docs. es-gateway pg-gateway labels Dec 22, 2020
@kalroy kalroy force-pushed the kallol/update_docs_pg_es_gateway_resolvers branch from 7e926b8 to 274a1b4 Compare December 22, 2020 12:31
@msorens msorens changed the title Added section on how to add resolvers for PG and ES gateways Doc update on how to add resolvers for PG and ES gateways Dec 22, 2020
kalroy and others added 4 commits December 22, 2020 15:35
Signed-off-by: Kallol Roy <karoy@progress.com>
Fixed the port number in the name-server examples

Signed-off-by: Kallol Roy <karoy@progress.com>
Signed-off-by: kagarmoe <kgarmoe@chef.io>
- Made the two new sections much more parallel with the same wording.
 - Applied fixes reported my markdownlint.
 - Spelling corrections.
 - More consistency for proper names, indents, wording.

Signed-off-by: michael sorens <msorens@chef.io>
@msorens msorens force-pushed the kallol/update_docs_pg_es_gateway_resolvers branch from 419b589 to 9ff1f4e Compare December 22, 2020 23:35
Copy link

@kagarmoe kagarmoe left a comment

Choose a reason for hiding this comment

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

tenor-51595308

@msorens msorens merged commit b21f670 into master Dec 23, 2020
@msorens msorens deleted the kallol/update_docs_pg_es_gateway_resolvers branch December 23, 2020 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants