Skip to content

docs: [CHAOS-9841]: Update docs for GCP auth to use SA JSON #11479

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: [CHAOS-9841]: Update docs for GCP auth to use SA JSON #11479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-sql-instance-failover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

### Mandatory tunables
Expand Down
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-vm-disk-loss-by-label.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

### Mandatory tunables
Expand Down
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-vm-disk-loss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

## Fault tunables
Expand Down
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-vm-instance-stop-by-label.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

### Mandatory tunables
Expand Down
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-vm-instance-stop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

### Mandatory tunables
Expand Down
24 changes: 14 additions & 10 deletions docs/chaos-engineering/faults/chaos-faults/gcp/gcp-vm-service-kill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,20 @@ metadata:
name: cloud-secret
type: Opaque
stringData:
type:
project_id:
private_key_id:
private_key:
client_email:
client_id:
auth_uri:
token_uri:
auth_provider_x509_cert_url:
client_x509_cert_url:
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

### Mandatory tunables
Expand Down
57 changes: 29 additions & 28 deletions ...ering/faults/chaos-faults/gcp/security-configurations/prepare-secret-for-gcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ Create a service account to derive the authentication secret to run experiments

1. Set your current project. Replace &lt;project-id&gt; with your project ID:

```bash
```bash
gcloud config set project <project-id>
```
```

2. Create a new service account. Replace &lt;service-account-name&gt; with the name you want to give to the service account:

```bash
gcloud iam service-accounts create <service-account-name>
```
```bash
gcloud iam service-accounts create <service-account-name>
```
### Step 2: Generate new JSON key file

3. After you create a new service account, generate a new JSON key file. Replace &lt;service-account-name&gt; with the name of your service account and &lt;key-file&gt; with the path where you want to save the key file:

```bash
gcloud iam service-accounts keys create <key-file> \
gcloud iam service-accounts keys create <key-file> \
--iam-account <service-account-name>@<project-id>.iam.gserviceaccount.com
```

Expand All @@ -37,15 +37,16 @@ The generated JSON key file will contain the fields you mentioned, and it looks
```json
{
"type": "service_account",
"project_id": "<project-id>",
"private_key_id": "<private-key-id>",
"private_key": "<private-key>",
"client_email": "<service-account-name>@<project-id>.iam.gserviceaccount.com",
"client_id": "<client-id>",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<service-account-name>%40<project-id>.iam.gserviceaccount.com"
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>",
"universe_domain": "googleapis.com"
}
```

Expand All @@ -59,25 +60,25 @@ The generated JSON key file will contain the fields you mentioned, and it looks
name: cloud-secret
type: Opaque
stringData:
type: "<type>"
project_id: "<project-id>"
private_key_id: "<private-key-id>"
private_key: <private-key>
client_email: "<client-email>"
client_id: "<client-id>"
auth_uri: "<auth-uri>"
token_uri: "<token-uri>"
auth_provider_x509_cert_url: "<auth-provider-x509-cert-url>"
client_x509_cert_url: "<client-x509-cert-url>"
gcp.auth: |-
{
"type": "service_account",
"project_id": "<PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "<CLIENT_X509_CERT_URL>"
"universe_domain": "googleapis.com"
}
```

:::warning
Newline (\n) characters within the private key are crucial. Avoid using double quotes to prevent their loss.
:::

### Step 4: Apply the secret YAML in desired namespace
5. Apply the secret YAML file you created earlier in the chaos infrastructure namespace using the command:

```bash
```bash
kubectl apply -f secret.yaml -n <CHAOS-NAMESPACE>
```
```