You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/postgresql_credential.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_credential Data Source - stackit"
4
4
subcategory: ""
5
5
description: |-
6
6
PostgreSQL credential data source schema. Must have a region specified in the provider configuration.
7
-
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexuser instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
7
+
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_user instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
Copy file name to clipboardExpand all lines: docs/data-sources/postgresql_instance.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_instance Data Source - stackit"
4
4
subcategory: ""
5
5
description: |-
6
6
PostgreSQL instance data source schema. Must have a region specified in the provider configuration.
7
-
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexinstance instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
7
+
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_instance instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
Copy file name to clipboardExpand all lines: docs/index.md
+23-12Lines changed: 23 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,20 +59,23 @@ When setting up authentication, the provider will always try to use the key flow
59
59
60
60
### Key flow
61
61
62
-
To use the key flow, you need to have a service account key and an RSA key-pair.
63
-
To configure it, follow this steps:
62
+
The following instructions assume that you have created a service account and assigned the necessary permissions to it, e.g. `project.owner`.
64
63
65
-
The following instructions assume that you have created a service account and assigned it the necessary permissions, e.g. project.owner.
64
+
To use the key flow, you need to have a service account key, which must have an RSA key-pair attached to it.
66
65
67
-
1. In the Portal, go to the `Service Accounts` tab, choose a `Service Account` and go to `Service Account Keys`to create a key.
66
+
When creating the service account key, a new pair can be created automatically, which will be included in the service account key. This will make it much easier to configure the key flow authentication in the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit), by just providing the service account key.
68
67
69
-
- You can create your own RSA key-pair or have the Portal generate one for you.
68
+
**Optionally**, you can provide your own private key when creating the service account key, which will then require you to also provide it explicitly to the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit), additionally to the service account key. Check the STACKIT Knowledge Base for an [example of how to create your own key-pair](https://docs.stackit.cloud/stackit/en/usage-of-the-service-account-keys-in-stackit-175112464.html#UsageoftheserviceaccountkeysinSTACKIT-CreatinganRSAkey-pair).
70
69
71
-
2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file.
70
+
To configure the key flow, follow this steps:
72
71
73
-
**Hint:** If you have generated the RSA key-pair using the Portal, you can save the private key in a PEM encoded file by downloading the service account key as a PEM file and using `openssl storeutl -keys <path/to/sa_key_pem_file> > private.key` to extract the private key from the service account key.
72
+
1. Create a service account key:
74
73
75
-
The expected format of the service account key is a **json** with the following structure:
74
+
- Use the [STACKIT Portal](https://portal.stackit.cloud/): go to the `Service Accounts` tab, choose a `Service Account` and go to `Service Account Keys` to create a key. For more details, see [Create a service account key](https://docs.stackit.cloud/stackit/en/create-a-service-account-key-175112456.html)
75
+
76
+
2. Save the content of the service account key by copying it and saving it in a JSON file.
77
+
78
+
The expected format of the service account key is a **JSON** with the following structure:
76
79
77
80
```json
78
81
{
@@ -94,10 +97,18 @@ The expected format of the service account key is a **json** with the following
94
97
}
95
98
```
96
99
97
-
3. Configure the service account key and private key for authentication in the provider by following one of the alternatives below:
98
-
- setting the fiels in the provider block: `service_account_key` or `service_account_key_path`, `private_key` or `private_key_path`
99
-
- setting environment variables: `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH`
100
-
- setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)
100
+
3. Configure the service account key for authentication in the provider by following one of the alternatives below:
101
+
102
+
- setting the fields in the provider block: `service_account_key` or `service_account_key_path`
103
+
- setting the environment variable: `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
104
+
- setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` in the credentials file (see above)
105
+
106
+
> **Optionally, only if you have provided your own RSA key-pair when creating the service account key**, you also need to configure your private key (takes precedence over the one included in the service account key, if present). **The private key must be PEM encoded** and can be provided using one of the options below:
107
+
>
108
+
> - setting the field in the provider block: `private_key` or `private_key_path`
109
+
> - setting the environment variable: `STACKIT_PRIVATE_KEY_PATH`
110
+
> - setting `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)
PostgreSQL credential resource schema. Must have a region specified in the provider configuration.
7
-
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexuser instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
7
+
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_user instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
PostgreSQL instance resource schema. Must have a region specified in the provider configuration.
7
-
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexinstance instead. Check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html on how to backup and restore an instance from PostgreSQL to PostgreSQL Flex, then import the resource to Terraform using an "import" block (https://developer.hashicorp.com/terraform/language/import)
7
+
!> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_instance instead. Check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html on how to backup and restore an instance from PostgreSQL to PostgreSQL Flex, then import the resource to Terraform using an "import" block (https://developer.hashicorp.com/terraform/language/import)
Copy file name to clipboardExpand all lines: templates/index.md.tmpl
+23-12Lines changed: 23 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -33,20 +33,23 @@ When setting up authentication, the provider will always try to use the key flow
33
33
34
34
### Key flow
35
35
36
-
To use the key flow, you need to have a service account key and an RSA key-pair.
37
-
To configure it, follow this steps:
36
+
The following instructions assume that you have created a service account and assigned the necessary permissions to it, e.g.`project.owner`.
38
37
39
-
The following instructions assume that you have created a service account and assigned it the necessary permissions, e.g. project.owner.
38
+
To use the key flow, you need to have a service account key, which must have an RSA key-pair attached to it.
40
39
41
-
1. In the Portal, go to the `Service Accounts` tab, choose a `Service Account`and go to `Service Account Keys`to create a key.
40
+
When creating the service account key, a new pair can be created automatically, which will be included in the service account key. This will make it much easier to configure the key flow authentication in the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit), by just providing the service account key.
42
41
43
-
- You can create your own RSA key-pair or have the Portal generate one for you.
42
+
**Optionally**, you can provide your own private key when creating the service account key, which will then require you to also provide it explicitly to the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit), additionally to the service account key. Check the STACKIT Knowledge Base for an [example of how to create your own key-pair](https://docs.stackit.cloud/stackit/en/usage-of-the-service-account-keys-in-stackit-175112464.html#UsageoftheserviceaccountkeysinSTACKIT-CreatinganRSAkey-pair).
44
43
45
-
2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file.
44
+
To configure the key flow, follow this steps:
46
45
47
-
**Hint:** If you have generated the RSA key-pair using the Portal, you can save the private key in a PEM encoded file by downloading the service account key as a PEM file and using `openssl storeutl -keys <path/to/sa_key_pem_file> > private.key` to extract the private key from the service account key.
46
+
1. Create a service account key:
48
47
49
-
The expected format of the service account key is a **json** with the following structure:
48
+
- Use the [STACKIT Portal](https://portal.stackit.cloud/): go to the `Service Accounts` tab, choose a `Service Account`and go to `Service Account Keys` to create a key. For more details, see [Create a service account key](https://docs.stackit.cloud/stackit/en/create-a-service-account-key-175112456.html)
49
+
50
+
2. Save the content of the service account key by copying it and saving it in a JSON file.
51
+
52
+
The expected format of the service account key is a **JSON** with the following structure:
50
53
51
54
```json
52
55
{
@@ -68,10 +71,18 @@ The expected format of the service account key is a **json** with the following
68
71
}
69
72
```
70
73
71
-
3. Configure the service account key and private key for authentication in the provider by following one of the alternatives below:
72
-
- setting the fiels in the provider block: `service_account_key`or`service_account_key_path`, `private_key`or`private_key_path`
- setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`and`STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)
74
+
3. Configure the service account key for authentication in the provider by following one of the alternatives below:
75
+
76
+
- setting the fields in the provider block: `service_account_key`or`service_account_key_path`
77
+
- setting the environment variable: `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
78
+
- setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` in the credentials file (see above)
79
+
80
+
> **Optionally, only if you have provided your own RSA key-pair when creating the service account key**, you also need to configure your private key (takes precedence over the one included in the service account key, if present). **The private key must be PEM encoded** and can be provided using one of the options below:
81
+
>
82
+
> - setting the field in the provider block: `private_key`or`private_key_path`
83
+
> - setting the environment variable: `STACKIT_PRIVATE_KEY_PATH`
84
+
> - setting `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above)
0 commit comments