Documentation of Process to Upgrade AMI for AWS Deployment #7680

bvtejaswi · 2023-01-20T12:17:38Z

🔩 Description: What code changed, and why?

Created a Docs Page where the Process to Upgrade AMI for AWS Deployment is shown with Backup and Restore method

⛓️ Related Resources

https://chefio.atlassian.net/browse/MADROX-421

👍 Definition of Done

Documentation where the Process to Upgrade AMI for AWS Deployment via Backup and Restore method.

👟 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-01-20T12:17:43Z

✅ Deploy Preview for chef-automate ready!

Name	Link
🔨 Latest commit	`644f814`
🔍 Latest deploy log	https://app.netlify.com/sites/chef-automate/deploys/63d3cccb6798ae00081361d7
😎 Deploy Preview	https://deploy-preview-7680--chef-automate.netlify.app/automate/ha_upgrade_introduction
📱 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.

ArvinthC3000 · 2023-01-24T10:38:35Z

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

+For Disaster Recovery or AMI upgarde, while running the restore in secondary cluster which is in different region follow the steps given below.
+
+-  First, Take the bakup in Secondary Cluster
+-  Then make a curl request `curl -XGET https://localhost:9200/_snapshot?pretty -u admin:admin -k`


This CURL is only supported in the OpenSearch node. Make sure to mention that, or add the endpoint to make same request from Automate Node

ArvinthC3000 · 2023-01-24T10:39:36Z

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

+-  First, Take the bakup in Secondary Cluster
+-  Then make a curl request `curl -XGET https://localhost:9200/_snapshot?pretty -u admin:admin -k`
+-  check the curl request response if the region is not matching with the primary cluster follow the below steps:
+1. Modify the region in fe nodes by patching the below configs with command, `chef-automate config patch <file-name>.toml --fe`


Suggested change

1. Modify the region in fe nodes by patching the below configs with command, `chef-automate config patch <file-name>.toml --fe`

1. Modify the region in the FrontEnd nodes by patching the below configs with command, `chef-automate config patch <file-name>.toml --fe`

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

ArvinthC3000 · 2023-01-24T10:46:24Z

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

+
+{{< note >}}
+
+  The AWS deployment should be configured with S3.  


Add more details to this note.

Which S3 bucket should be configured to the new (upgraded) cluster setup

Now with MADROX-427, user can directly mention existing bucket name in config.toml

ArvinthC3000 · 2023-01-24T10:48:05Z

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

+
+### Steps to set up the AMI Upgraded Cluster
+
+1. Deploy the Primary cluster following the deployment instructions by [clicking here](/automate/ha_aws_deploy_steps/#deployment).


The assumption here is the user will already have a Primary setup (in case of an AMI upgrade). Do we need to mention Step 1?

Should we use the terminology Primary/Secondary cluster, or can we call this something else ?

As Discussed ,used Primary and New cluster

ArvinthC3000 · 2023-01-24T10:50:30Z

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

+    - Copy `bootstrap.abb` to all Automate and Chef Infra frontend nodes in the Secondary cluster.
+
+
+1. On New AMI upgraded Cluster


Either we can use New Cluster with upgraded AMI or Secondary Cluster(?)

ArvinthC3000 · 2023-01-24T10:52:08Z

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

+    chef-automate backup list
+    ```
+
+    -On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.


Suggested change

-On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.

- On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.

ArvinthC3000 · 2023-01-24T10:53:13Z

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

+
+    -On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.
+
+        - To run the restore command, you need the airgap bundle. Get the Automate HA airgap bundle from the location `/var/tmp/` in Automate instance. For example: `frontend-4.x.y.aib`.


Below this line, the Preview link is showing as code snippets for all the descriptions

ArvinthC3000 · 2023-01-24T10:55:41Z

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

+
+### Switch to New Upgraded Cluster
+
+Steps to switch to the New cluster are as follows:


Include steps to re-configure user's DNS to new set of Loadbalances created in the New cluster with upgraded AMIs

ArvinthC3000 · 2023-01-24T14:41:26Z

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

+
+In the above approach, there will be two identical clusters
+
+- Primary Cluster (or Production Cluster)


Suggested change

- Primary Cluster (or Production Cluster)

- Primary Cluster

punitmundra

do the change, other than that ..doc is fine

bvtejaswi · 2023-01-27T11:14:14Z

do the change, other than that ..doc is fine

All the changes are done now.

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

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

vivekshankar1 · 2023-01-27T12:46:18Z

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

+    chef-automate backup create --no-progress > /var/log/automate-backups.log
+    ```
+
+    - Create a bootstrap bundle; this bundle captures any local credentials or secrets that aren't persisted to the database. To create the bootstrap bundle, run the following command in one of the Automate nodes:


Suggested change

- Create a bootstrap bundle; this bundle captures any local credentials or secrets that aren't persisted to the database. To create the bootstrap bundle, run the following command in one of the Automate nodes:

- Create a bootstrap bundle, this bundle captures any local credentials or secrets that aren't persisted in the database. To create the bootstrap bundle, run the following command in one of the Automate nodes:

dishanktiwari2501

Fixed The Doc Changes.

vivekshankar1 · 2023-01-27T12:56:23Z

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

+
+    - On New Cluster Trigger restore command from bastion. 
+
+        - To run the restore command, you need to add the OpenSearch credentials to the applied config. If using Chef Managed OpenSearch,we need to have automate config.Run the below command in the Chef-Automate node to get the applied config into `current_config.toml`:


Suggested change

- To run the restore command, you need to add the OpenSearch credentials to the applied config. If using Chef Managed OpenSearch,we need to have automate config.Run the below command in the Chef-Automate node to get the applied config into `current_config.toml`:

- For Chef Managed OpenSearch follow the below steps:

vivekshankar1 · 2023-01-27T12:59:39Z

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


+- Once the restore is successful ,you can destroy the Primary Cluster.


Suggested change

- Once the restore is successful ,you can destroy the Primary Cluster.

- Once the restore is successful you can destroy the Primary Cluster.

vivekshankar1 · 2023-01-27T13:01:46Z

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

+
+        ```
+
+- If you want to reuse the same custom domain used previously, then make sure to update the DNS entry to the Load-Balancer FQDN of the New cluster.


Suggested change

- If you want to reuse the same custom domain used previously, then make sure to update the DNS entry to the Load-Balancer FQDN of the New cluster.

- If you want to reuse the same custom domain used previously, update your DNS record to point to the Load-Balancer of the new cluster.

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

sonarcloud · 2023-01-27T13:35:00Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

* Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> * Documentation for AMI upgrade Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com> Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

bvtejaswi requested a review from a team as a code owner January 20, 2023 12:17

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

bvtejaswi requested review from vivek-yadav, ArvinthC3000, punitmundra and jayvikramsharma1 January 23, 2023 06:20

ArvinthC3000 reviewed Jan 24, 2023

View reviewed changes

components/docs-chef-io/content/automate/ha_upgrade_introduction.md Outdated Show resolved Hide resolved

ArvinthC3000 reviewed Jan 24, 2023

View reviewed changes

bvtejaswi force-pushed the tejaswi/ami-upgrade branch from b073b50 to aeecb4f Compare January 24, 2023 15:20

bvtejaswi requested a review from ArvinthC3000 January 25, 2023 10:07

bvtejaswi force-pushed the tejaswi/ami-upgrade branch 2 times, most recently from f451a8b to 5cdab19 Compare January 25, 2023 12:23

punitmundra approved these changes Jan 27, 2023

View reviewed changes

bvtejaswi force-pushed the tejaswi/ami-upgrade branch from 5cdab19 to c0fadba Compare January 27, 2023 10:45

vivek-yadav approved these changes Jan 27, 2023

View reviewed changes

ArvinthC3000 approved these changes Jan 27, 2023

View reviewed changes

ArvinthC3000 reviewed Jan 27, 2023

View reviewed changes

components/docs-chef-io/content/automate/ha_upgrade_introduction.md Outdated Show resolved Hide resolved

bvtejaswi added 3 commits January 27, 2023 17:21

Documentation for AMI upgrade

17e78e1

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

Documentation for AMI upgrade

ab7819f

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

Documentation for AMI upgrade

d33173f

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

bvtejaswi added 2 commits January 27, 2023 17:21

Documentation for AMI upgrade

21365f9

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

Documentation for AMI upgrade

d30979f

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

bvtejaswi force-pushed the tejaswi/ami-upgrade branch from c0fadba to d30979f Compare January 27, 2023 11:55

vivekshankar1 reviewed Jan 27, 2023

View reviewed changes

dishanktiwari2501 approved these changes Jan 27, 2023

View reviewed changes

vivekshankar1 reviewed Jan 27, 2023

View reviewed changes

Documentation for AMI upgrade

935a029

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

bvtejaswi force-pushed the tejaswi/ami-upgrade branch from 34c15b8 to 935a029 Compare January 27, 2023 13:04

Documentation for AMI upgrade

644f814

Signed-off-by: Tejaswi Bondila <bondila.venkatatejaswi@progress.com>

vivek-yadav approved these changes Jan 27, 2023

View reviewed changes

vivek-yadav merged commit 58d822a into main Jan 27, 2023

vivek-yadav deleted the tejaswi/ami-upgrade branch January 27, 2023 13:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation of Process to Upgrade AMI for AWS Deployment #7680

Documentation of Process to Upgrade AMI for AWS Deployment #7680

bvtejaswi commented Jan 20, 2023 •

edited

Loading

netlify bot commented Jan 20, 2023 •

edited

Loading

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023 •

edited

Loading

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 24, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 25, 2023

ArvinthC3000 Jan 24, 2023

bvtejaswi Jan 25, 2023

punitmundra left a comment

bvtejaswi commented Jan 27, 2023

vivekshankar1 Jan 27, 2023

dishanktiwari2501 left a comment

vivekshankar1 Jan 27, 2023

vivekshankar1 Jan 27, 2023

vivekshankar1 Jan 27, 2023 •

edited

Loading

sonarcloud bot commented Jan 27, 2023

	1. Modify the region in fe nodes by patching the below configs with command, `chef-automate config patch <file-name>.toml --fe`
	1. Modify the region in the FrontEnd nodes by patching the below configs with command, `chef-automate config patch <file-name>.toml --fe`


		{{< note >}}

		The AWS deployment should be configured with S3.


		### Steps to set up the AMI Upgraded Cluster

		1. Deploy the Primary cluster following the deployment instructions by [clicking here](/automate/ha_aws_deploy_steps/#deployment).

		- Copy `bootstrap.abb` to all Automate and Chef Infra frontend nodes in the Secondary cluster.


		1. On New AMI upgraded Cluster

	-On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.
	- On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.


		-On Secondary Cluster Trigger restore command `chef-automate backup restore` on one of the Chef Automate nodes.

		- To run the restore command, you need the airgap bundle. Get the Automate HA airgap bundle from the location `/var/tmp/` in Automate instance. For example: `frontend-4.x.y.aib`.


		### Switch to New Upgraded Cluster

		Steps to switch to the New cluster are as follows:


		In the above approach, there will be two identical clusters

		- Primary Cluster (or Production Cluster)

	- Create a bootstrap bundle; this bundle captures any local credentials or secrets that aren't persisted to the database. To create the bootstrap bundle, run the following command in one of the Automate nodes:
	- Create a bootstrap bundle, this bundle captures any local credentials or secrets that aren't persisted in the database. To create the bootstrap bundle, run the following command in one of the Automate nodes:


		- On New Cluster Trigger restore command from bastion.

		- To run the restore command, you need to add the OpenSearch credentials to the applied config. If using Chef Managed OpenSearch,we need to have automate config.Run the below command in the Chef-Automate node to get the applied config into `current_config.toml`:

	- To run the restore command, you need to add the OpenSearch credentials to the applied config. If using Chef Managed OpenSearch,we need to have automate config.Run the below command in the Chef-Automate node to get the applied config into `current_config.toml`:
	- For Chef Managed OpenSearch follow the below steps:


		- Once the restore is successful ,you can destroy the Primary Cluster.

	- Once the restore is successful ,you can destroy the Primary Cluster.
	- Once the restore is successful you can destroy the Primary Cluster.


		```

		- If you want to reuse the same custom domain used previously, then make sure to update the DNS entry to the Load-Balancer FQDN of the New cluster.

Documentation of Process to Upgrade AMI for AWS Deployment #7680

Documentation of Process to Upgrade AMI for AWS Deployment #7680

Conversation

bvtejaswi commented Jan 20, 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 Jan 20, 2023 • edited Loading

✅ Deploy Preview for chef-automate ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArvinthC3000 Jan 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

punitmundra left a comment

Choose a reason for hiding this comment

bvtejaswi commented Jan 27, 2023

Choose a reason for hiding this comment

dishanktiwari2501 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vivekshankar1 Jan 27, 2023 • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented Jan 27, 2023

bvtejaswi commented Jan 20, 2023 •

edited

Loading

netlify bot commented Jan 20, 2023 •

edited

Loading

ArvinthC3000 Jan 24, 2023 •

edited

Loading

vivekshankar1 Jan 27, 2023 •

edited

Loading