fix chef-automate test command exit error and ha cert doc update #7898

vivekshankar1 · 2023-05-18T12:55:00Z

🔩 Description: What code changed, and why?

Added Triple Quotes to default init-config-ha template for certificates
Added Triple Quotes everywhere we used certificates in docs for onprem, aws and aws managed pages
Added notes for multiline certificates about using them like """cert"""
Fixed chef-automate test command not exiting gracefully error.
Created a dedicated page for AWS OpenSearch creation, providing step-by-step instructions and guidelines for setting up OpenSearch on AWS.
Created a separate page for AWS RDS creation, offering detailed instructions on setting up RDS (Relational Database Service) on AWS.
Updated Create RDS and create OpenSearch links in onprem with AWS managed service page and AWS with AWS managed service pages.
in AWS with Managed AWS Services, changed OpenSearch verison from 1.3.7 to 1.3 since 1.3.7 is not available as an option in aws cli or console
For AWS pages updated automate and chef-server default instance count from 1 to 2
For AWS with managed page updated pg/os default instance count from 3 to 0
Updated text for common password and username for superuser and dbuser on onprem with aws managed/self managed and aws with aws managed pages
Clearly mentioned automate rootca as automate load balancer rootca, mentioned private/public keys as node internal keys. Also mentioned the same in cert rotate command as well
Added LC_ALL and LANG exports in infra server to HA migration page

⛓️ Related Resources

https://chefio.atlassian.net/browse/CHEF-3216

👍 Definition of Done

👟 How to Build and Test the Change

✅ Checklist

All PRs must tick these:

I have read the CONTRIBUTING document.
All commits signed-off for the Developer Certification of Origin.

With occasional exceptions, all PRs from Progress employees must tick these:

Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

Tests added/updated? (all new code needs new tests)
Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

netlify · 2023-05-18T12:55:07Z

✅ Deploy Preview for chef-automate ready!

Name	Link
🔨 Latest commit	`da30068`
🔍 Latest deploy log	https://app.netlify.com/sites/chef-automate/deploys/6475ee41d2230000080501fe
😎 Deploy Preview	https://deploy-preview-7898--chef-automate.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

vivek-yadav · 2023-05-19T07:24:05Z

components/docs-chef-io/content/automate/ha_aws_deploy_steps.md

-# public_key = ""
+# Add Automate load balancer root-ca and keys
+# root_ca = """root_ca_contents"""
+# private_key = """private_key_contents"""


Suggested change

# private_key = """private_key_contents"""

## Private and Public keys are only needed if self generated certs are used for Automate Nodes.

# private_key = """private_key_contents"""

Signed-off-by: Vivek Shankar <vshankar@progress.com>

Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>

dishanktiwari2501

Made the possible changes directly to the PR.
Hence, approving!

Signed-off-by: Vivek Shankar <vshankar@progress.com>

sonarqube-for-infrastructure-prod · 2023-05-30T13:03:10Z

SonarQube Quality Gate

0.0% Coverage on New Code (is less than 80%)

See analysis details on SonarQube

* fix automate test command Signed-off-by: Vivek Shankar <vshankar@progress.com> * doc changes for ha certificates Signed-off-by: Vivek Shankar <vshankar@progress.com> * changes for lb root ca Signed-off-by: Vivek Shankar <vshankar@progress.com> * added pages for rds and os Signed-off-by: Vivek Shankar <vshankar@progress.com> * added page tags Signed-off-by: Vivek Shankar <vshankar@progress.com> * small formatting Signed-off-by: Vivek Shankar <vshankar@progress.com> * small changes Signed-off-by: Vivek Shankar <vshankar@progress.com> * formatted Signed-off-by: Vivek Shankar <vshankar@progress.com> * typo Signed-off-by: Vivek Shankar <vshankar@progress.com> * updates create pg os references Signed-off-by: Vivek Shankar <vshankar@progress.com> * updated link Signed-off-by: Vivek Shankar <vshankar@progress.com> * updated link Signed-off-by: Vivek Shankar <vshankar@progress.com> * updated link Signed-off-by: Vivek Shankar <vshankar@progress.com> * updated title Signed-off-by: Vivek Shankar <vshankar@progress.com> * updated version Signed-off-by: Vivek Shankar <vshankar@progress.com> * aws doc link Signed-off-by: Vivek Shankar <vshankar@progress.com> * added more Signed-off-by: Vivek Shankar <vshankar@progress.com> * added more Signed-off-by: Vivek Shankar <vshankar@progress.com> * added small change Signed-off-by: Vivek Shankar <vshankar@progress.com> * added small change Signed-off-by: Vivek Shankar <vshankar@progress.com> * added small change Signed-off-by: Vivek Shankar <vshankar@progress.com> * added small change Signed-off-by: Vivek Shankar <vshankar@progress.com> * link changes Signed-off-by: Vivek Shankar <vshankar@progress.com> * add export to infra restore Signed-off-by: Vivek Shankar <vshankar@progress.com> * add export to infra restore Signed-off-by: Vivek Shankar <vshankar@progress.com> * self managed pg text Signed-off-by: Vivek Shankar <vshankar@progress.com> * made some formattting changes Signed-off-by: dishanktiwari2501 <dtiwari@progress.com> * change heading and format Signed-off-by: Vivek Shankar <vshankar@progress.com> --------- Signed-off-by: Vivek Shankar <vshankar@progress.com> Signed-off-by: dishanktiwari2501 <dtiwari@progress.com> Co-authored-by: dishanktiwari2501 <dtiwari@progress.com>

vivekshankar1 marked this pull request as ready for review May 18, 2023 12:55

vivekshankar1 requested a review from a team as a code owner May 19, 2023 07:20

github-actions bot added the documentation Anything related to the Automate docs. label May 19, 2023

vivekshankar1 changed the title ~~fix chef-automate test command exit error~~ fix chef-automate test command exit error and ha cert doc update May 19, 2023

vivek-yadav reviewed May 19, 2023

View reviewed changes

vivekshankar1 force-pushed the vs/fix_automate_test_exit_err branch from 1c8d00c to d4d54e2 Compare May 22, 2023 10:30

punitmundra approved these changes May 22, 2023

View reviewed changes

vivekshankar1 added 4 commits May 25, 2023 21:08

fix automate test command

dece5f5

Signed-off-by: Vivek Shankar <vshankar@progress.com>

doc changes for ha certificates

4f8bac5

Signed-off-by: Vivek Shankar <vshankar@progress.com>

changes for lb root ca

7ace093

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added pages for rds and os

7d1e78a

Signed-off-by: Vivek Shankar <vshankar@progress.com>

vivekshankar1 force-pushed the vs/fix_automate_test_exit_err branch from d4d54e2 to 7d1e78a Compare May 25, 2023 15:40

vivekshankar1 added 17 commits May 25, 2023 21:15

added page tags

69cb525

Signed-off-by: Vivek Shankar <vshankar@progress.com>

small formatting

bb9457a

Signed-off-by: Vivek Shankar <vshankar@progress.com>

small changes

ef9cb14

Signed-off-by: Vivek Shankar <vshankar@progress.com>

formatted

35ad174

Signed-off-by: Vivek Shankar <vshankar@progress.com>

typo

3beeb99

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updates create pg os references

d89febe

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updated link

7e8575d

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updated link

4390a38

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updated link

f6c9c62

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updated title

3add1a1

Signed-off-by: Vivek Shankar <vshankar@progress.com>

updated version

363009c

Signed-off-by: Vivek Shankar <vshankar@progress.com>

aws doc link

5c714f8

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added more

8aea0b0

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added more

337ee51

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added small change

5795c77

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added small change

cf412f6

Signed-off-by: Vivek Shankar <vshankar@progress.com>

added small change

93d342c

Signed-off-by: Vivek Shankar <vshankar@progress.com>

vivekshankar1 and others added 6 commits May 30, 2023 11:56

added small change

ac7fa05

Signed-off-by: Vivek Shankar <vshankar@progress.com>

link changes

b97858c

Signed-off-by: Vivek Shankar <vshankar@progress.com>

add export to infra restore

78093c9

Signed-off-by: Vivek Shankar <vshankar@progress.com>

add export to infra restore

0a4d063

Signed-off-by: Vivek Shankar <vshankar@progress.com>

self managed pg text

95ac71b

Signed-off-by: Vivek Shankar <vshankar@progress.com>

made some formattting changes

d04a159

Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>

dishanktiwari2501 approved these changes May 30, 2023

View reviewed changes

vivek-yadav approved these changes May 30, 2023

View reviewed changes

vivekshankar1 added 2 commits May 30, 2023 18:05

change heading and format

ed21011

Signed-off-by: Vivek Shankar <vshankar@progress.com>

change heading and format

da30068

Signed-off-by: Vivek Shankar <vshankar@progress.com>

vivek-yadav merged commit 8892a73 into main May 30, 2023
5 of 8 checks passed

vivek-yadav deleted the vs/fix_automate_test_exit_err branch May 30, 2023 14:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix chef-automate test command exit error and ha cert doc update #7898

fix chef-automate test command exit error and ha cert doc update #7898

vivekshankar1 commented May 18, 2023 •

edited

Loading

netlify bot commented May 18, 2023 •

edited

Loading

vivek-yadav May 19, 2023

dishanktiwari2501 left a comment

sonarqube-for-infrastructure-prod bot commented May 30, 2023

	# private_key = """private_key_contents"""
	## Private and Public keys are only needed if self generated certs are used for Automate Nodes.
	# private_key = """private_key_contents"""

fix chef-automate test command exit error and ha cert doc update #7898

fix chef-automate test command exit error and ha cert doc update #7898

Conversation

vivekshankar1 commented May 18, 2023 • edited Loading

🔩 Description: What code changed, and why?

⛓️ Related Resources

👍 Definition of Done

👟 How to Build and Test the Change

✅ Checklist

📷 Screenshots, if applicable

netlify bot commented May 18, 2023 • edited Loading

✅ Deploy Preview for chef-automate ready!

vivek-yadav May 19, 2023

Choose a reason for hiding this comment

dishanktiwari2501 left a comment

Choose a reason for hiding this comment

sonarqube-for-infrastructure-prod bot commented May 30, 2023

vivekshankar1 commented May 18, 2023 •

edited

Loading

netlify bot commented May 18, 2023 •

edited

Loading