feat: add documentation on how to add AWS, GCP and Huawei to PipeOps

Sobowale-Olayiwola · Sobowale-Olayiwola · commit 66d13ac020d7 · 2025-01-26T02:03:22.000+01:00
diff --git a/docs/how-to-guides/tutorials/connect-aws.md b/docs/how-to-guides/tutorials/connect-aws.md
@@ -0,0 +1,49 @@
+---
+sidebar_position: 5
+title: Connecting AWS Account to PipeOps
+slug: connect-aws
+---
+
+# Connecting AWS Account to PipeOps
+
+## Overview
+
+This documentation guides you through the process of connecting your AWS account to PipeOps. This would enable you to create an AWS server on PipeOps and deploy projects on the server.
+
+## Steps to follow
+
+To connect your AWS account to PipeOps, follow these steps:
+
+1. On the left menu, click on "Integrations" tab.
+
+![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
+
+2. Click on the AWS button among the list of cloud providers shown.
+
+![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
+
+3. On the "Connect AWS" screen, you can provide an optional name to identify your AWS account. The optional field is useful in scenarios when you want to connect more than one(1) AWS account on PipeOps.
+
+![PipeOps AWS Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSConnectionTab.png)
+
+4. Fill in your AWS Account ID found at the top-right corner of your AWS account and an optional name.
+
+![PipeOps AWS Connection screen filled](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSConnectionFormFilled.png)
+
+5. After filling the form. Click on the "Add" button, then a spinner loads before enabling the "Authorize IAM" button.
+
+6. Click on "Authorize IAM" button. It should open a new tab to the right, opening a "Create Stacks" page on your AWS account which would need you to acknowledge "that AWS CloudFormation might create IAM resources with customised names
+" on the bottom of the page. Then click on the "Create stack" button at the bottom right of the page.
+
+![PipeOps AWS Create Cloud Formation Stacks Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSCreateStacksPage.png)
+
+7. After clicking the "Create stack" button. You will have a page similar to this.
+
+![PipeOps AWS Create Cloud Formation Stack In Progess Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSCreateStackInProgress.png)
+
+8. You can switch back to your PipeOps tab to the left and wait for few seconds and your AWS account would automatically get connected.
+
+![PipeOps AWS Create Cloud Formation Stack In Progess Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSAccountConnected.png)
+
+Now that you have connected your AWS account on PipeOps, you can now create a server to your connected AWS account using this guide [here](/docs/servers/server-provisioning).
+
diff --git a/docs/how-to-guides/tutorials/connect-gcp.md b/docs/how-to-guides/tutorials/connect-gcp.md
@@ -0,0 +1,38 @@
+---
+sidebar_position: 6
+title: Connecting GCP Account to PipeOps
+slug: connect-gcp
+---
+
+# Connecting GCP Account to PipeOps
+
+## Overview
+
+This documentation guides you through the process of connecting your GCP account to PipeOps. This would enable you to create an GCP server on PipeOps and deploy projects on the server.
+
+
+## Steps to follow
+
+To connect your GCP account to PipeOps, follow these steps:
+
+1. Ensure you have downloaded your GCP JSON credentials. If not, you can follow this guide [here](/docs/how-to-guides/tutorials/generate-gcp-json-credentials).
+
+2. On the left menu, click on "Integrations" tab.
+
+![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
+
+3. Click on the GCP button among the list of cloud providers shown and click the "Proceed" button at the bottom right.
+
+![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
+
+
+4. On the "Upload Credentials JSON" screen, you can provide an optional name to identify your uploaded GCP JSON credentials. The optional field is useful in scenarios when you want to connect more than one(1) GCP account on PipeOps.
+
+![PipeOps GCP JSON Credentials Upload Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsGCPJSONCredentialsFilled.png)
+
+5. Click on the submit button at the bottom right and if the JSON credentials is valid, then your GCP Account is successfully connected.
+
+![PipeOps GCP Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsGCPCredentialsUploaded.png)
+
+Now that you have connected your GCP account on PipeOps, you can now create a server to your connected GCP account using this guide [here](/docs/servers/server-provisioning).
+
diff --git a/docs/how-to-guides/tutorials/connect-huawei.md b/docs/how-to-guides/tutorials/connect-huawei.md
@@ -0,0 +1,37 @@
+---
+sidebar_position: 7
+title: Connecting Huawei Account to PipeOps
+slug: connect-huawei
+---
+
+# Connecting Huawei Account to PipeOps
+
+## Overview
+
+This documentation guides you through the process of connecting your Huawei account to PipeOps. This would enable you to create a Huawei server on PipeOps and deploy projects on the server.
+
+## Steps to follow
+
+To connect your Huawei account to PipeOps, follow these steps:
+
+1. Ensure you have downloaded your Huawei credentials which is a CSV file. If not, you can follow this guide [here](/docs/how-to-guides/tutorials/generate-huawei-credentials).
+
+2. On the left menu, click on "Integrations" tab.
+
+![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
+
+3. Click on the Huawei button among the list of cloud providers shown and click the "Proceed" button at the bottom right of the page.
+
+![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
+
+4. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Huawei account. The optional field is useful in scenarios when you want to connect more than one(1) Huawei account on PipeOps. Then provide your "Access Key" and "Secret Key" from the CSV file you downloaded. 
+
+
+![PipeOps Huawei Credentials Input Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsHuaweiCloudCredentialsForm.png)
+
+5. Click on the submit button at the bottom right and if the Huawei credentials is valid, then your Huawei Account is successfully connected.
+
+![PipeOps Huawei Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/HuaweiConnectionScreen.png)
+
+Now that you have connected your Huawei account on PipeOps, you can now create a server to your connected Huawei account using this guide [here](/docs/servers/server-provisioning).
+
diff --git a/docs/how-to-guides/tutorials/generate-gcp-json-credentials.md b/docs/how-to-guides/tutorials/generate-gcp-json-credentials.md
@@ -0,0 +1,46 @@
+---
+sidebar_position: 7
+title: Generate GCP JSON credentials
+slug: generate-gcp-json-credentials
+---
+
+Creating a GCP JSON credentials is required to connect your GCP Account to PipeOps. The followings steps would highlight how to generate the JSON credentials to be securely uploaded on PipeOps platform.
+
+1. [Connect to your GCP console](https://console.cloud.google.com/).
+
+2. Create a new Project or open an existing one
+
+![GCP New Project](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCreateGCPProject.png)
+
+3. Open the embedded Google shell
+
+![GCP Embedded Shell](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/gcp_shell_1.webp)
+
+4. Run the following command in the Google Shell to create the service account and generate the json key
+
+    
+        ```bash
+           curl https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/create_credentials_gcp.sh | \
+           bash -s -- $GOOGLE_CLOUD_PROJECT pipeops_role pipeops-service-account
+        ```
+    
+       You can modify:
+          - the service account name by replacing **pipeops-service-account** by the name of your choice
+          - the role name by replacing **pipeops_role** by the role name of your choice
+      
+
+5. Once the script is finished, you will see the following message:
+
+        ```
+        created key [xxxx] of type [json] as [key.json] for [pipeops-service-account@<your-project.iam.gserviceaccount.com]
+        Operations completed. You can now download your json key to upload in PipeOps
+        ```
+    So you can download it by clicking on the **Download** in the **Cloud Terminal Shell** window.
+
+    ![GCP JSON Credentials Download Step](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/gcp_shell_5.webp)
+
+    And specify the name of the file /your/home/key.json and click on Download.
+
+    ![GCP JSON Credentials Download Path](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/GCPJSONCredentialsDownload.png)
+    
+Congratulations you have successfully created your GCP JSON credentials.
diff --git a/docs/how-to-guides/tutorials/generate-huawei-credentials.md b/docs/how-to-guides/tutorials/generate-huawei-credentials.md
@@ -0,0 +1,34 @@
+---
+sidebar_position: 8
+title: Generate Huawei credentials
+slug: generate-huawei-credentials
+---
+
+Creating a Huwei credentials is required to connect your Huawei Account to PipeOps. The followings steps would highlight how to generate the credentials to be securely added on PipeOps platform.
+
+1. [Connect to your Huawei console](https://console-intl.huaweicloud.com).
+
+2. Create a new IAM User by clicking on the "Create User" button by the top right of the page.
+
+![Huawei New IAM User](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/CreateHuaweiIAMUser.png)
+
+3. Provide a unique **username** e.g PipeOpsIAMUser and ensure the followings
+    - Allow "Access Type" to be **__Programmatic access__**
+    - Enable  "Management console access"
+    - Credential Type should be enabled to use **__Access key__**
+    - Login Protection enabled
+
+![Set Huawei IAM User Details](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/SetHuaweiIAMUserDetails.png)
+
+Click on the "Next" button at the bottom right of the page.
+
+4. Select the check box for admin "Full permissions" and click the "Create" button at the bottom right of the page.
+
+![Set Huawei IAM User Permission](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/HuaweiIAMPermission.png)
+
+
+5. Ensure you download the created credentials which is a CSV file, by clicking the "OK" button first and "Download" button . The CSV contains your "User Name", "Access Key Id" and "Secret Access Key".
+
+![Set Huawei IAM User Permission](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/HuaweiCredentialsDownload.png)
+
+Congratulations you have successfully created your Huawei credentials.
diff --git a/yarn.lock b/yarn.lock
