Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilmulinti authored Mar 7, 2024
1 parent 4cb8fc1 commit abeca60
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
Installation Guide for DIGIT via GitHub Actions in AWS
**Installation Guide for DIGIT via GitHub Actions in AWS**

This guide provides step-by-step instructions for installing DIGIT using GitHub Actions within an AWS environment.
Prerequisites

**Prerequisites**

AWS account
Github account
Installation Steps:

**Installation Steps:**

Prepare AWS IAM User
Create an IAM User in your AWS account.
Generate ACCESS_KEY and SECRET_KEY for the IAM user.
Expand All @@ -15,6 +20,8 @@ AWS_ACCESS_KEY_ID: <GENERATED_ACCESS_KEY>
AWS_SECRET_ACCESS_KEY: <GENERATED_SECRET_KEY>
AWS_DEFAULT_REGION: ap-south-1
AWS_REGION: ap-south-1

Navigate to kubernetes-1.27 branch
Enable GitHub Actions
Open the GitHub Actions workflow file.
Specify the branch name you wish to enable GitHub Actions for.
Expand All @@ -33,16 +40,17 @@ openssl genpkey -algorithm RSA -out private_key.pem
openssl rsa -pubout -in private_key.pem -out public_key.pem
Finalize Installation
After entering all the details, push these changes to the remote GitHub repository. Open the Actions tab in your GitHub account to view the workflow. You should see that the workflow has started, and the pipelines are completing successfully.
Cleanup and Uninstallation of DIGIT Infrastructure

**Cleanup and Uninstallation of DIGIT Infrastructure**

As you wrap up your work with DIGIT, ensuring a smooth and error-free cleanup of the resources is crucial. Regular monitoring of the GitHub Actions workflow's output is essential during the destruction process. Watch out for any error messages or signs of issues. A successful job completion will be confirmed by a success message in the GitHub Actions window, indicating that the infrastructure has been effectively destroyed.
When you're ready to remove DIGIT and clean up the resources it created, proceed with executing the terraform_infra_destruction job. This action is designed to dismantle all setup resources, clearing the environment neatly.
We hope your experience with DIGIT was positive and that this guide makes the uninstallation process straightforward.
How to Run the Terraform Infrastructure Destruction Job

**How to Run the Terraform Infrastructure Destruction Job**
To initiate the destruction of a Terraform-managed infrastructure, follow these steps:
Navigate to Actions.
Click DIGIT-Install workflow.
Select Run workflow.
When prompted, type "destroy". This action starts the terraform_infra_destruction job.
You can observe the progress of the destruction job in the actions window.

Super user creation:

0 comments on commit abeca60

Please sign in to comment.