Skip to content

Commit 4a7c8b9

Browse files
authored
Merged automatically by CI pipeline
SCALRCORE-28573 Provider > Prepare docs for terraform registry
2 parents ee02e37 + 8c481fa commit 4a7c8b9

File tree

5 files changed

+10
-6
lines changed

5 files changed

+10
-6
lines changed

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ slug: "provider_overview"
55
order: 0
66
hidden: false
77
---
8+
# Scalr Provider
9+
810
The Scalr Terraform provider can be used to manage objects in Scalr with Terraform.
911

1012
Using the Scalr Terraform provider is a best practice as you scale your Terraform and Scalr operations. It is not required, but many customers have a Scalr admin environment and workspace(s), which use the provider to manage all other objects in Scalr.
@@ -54,7 +56,7 @@ If you have tokens stored in files locally, the `~/.terraform.d/credentials.tfrc
5456

5557
As mentioned, a best practice is to use the Scalr Terraform provider to manage objects within Scalr.
5658

57-
If you are using Scalr to execute the Terraform runs that call the Scalr provider, you must override a default token set for each run. The default token has minimal permissions to allow for the run execution, which means the run will fail if you don't set the `SCALR_TOKEN` variable in the workspace. It is recommended to use a [service account](/docs/identity-and-access-management#service-accounts) for the token.
59+
If you are using Scalr to execute the Terraform runs that call the Scalr provider, you must override a default token set for each run. The default token has minimal permissions to allow for the run execution, which means the run will fail if you don't set the `SCALR_TOKEN` variable in the workspace. It is recommended to use a [service account](https://docs.scalr.io/docs/identity-and-access-management#service-accounts) for the token.
5860

5961
![SCALR_TOKEN Variable](https://files.readme.io/2a1d8e3-Screen_Shot_2022-11-28_at_12.19.04_PM.png)
6062

@@ -68,4 +70,4 @@ Not sure where to get started? Take a look at the Ignite repo, which will deploy
6870
### Optional
6971

7072
- `hostname` (String) The Scalr hostname to connect to. Defaults to `scalr.io`. Can be overridden by setting the `SCALR_HOSTNAME` environment variable.
71-
- `token` (String) The token used to authenticate with Scalr. Can be overridden by setting the `SCALR_TOKEN` environment variable. See [Scalr provider configuration](/docs/scalr) for information on generating a token.
73+
- `token` (String) The token used to authenticate with Scalr. Can be overridden by setting the `SCALR_TOKEN` environment variable. See [Scalr provider configuration](https://docs.scalr.io/docs/scalr) for information on generating a token.

docs/resources/provider_configuration_default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ order: 12
1010

1111
Manage defaults of provider configurations for environments in Scalr. Create and destroy.
1212

13-
**Note:** To make the provider configuration default, it must be shared with the specified environment. See the definition of the resource [`scalr_provider_configuration`](provider_configuration.md) and attribute `environments` to learn more.
13+
**Note:** To make the provider configuration default, it must be shared with the specified environment. See the definition of the resource [`scalr_provider_configuration`](provider_resource_scalr_provider_configuration) and attribute `environments` to learn more.
1414

1515
## Example Usage
1616

scalr/provider.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func Provider() *schema.Provider {
5757
Optional: true,
5858
Description: "The token used to authenticate with Scalr." +
5959
" Can be overridden by setting the `SCALR_TOKEN` environment variable." +
60-
" See [Scalr provider configuration](/docs/scalr)" +
60+
" See [Scalr provider configuration](https://docs.scalr.io/docs/scalr)" +
6161
" for information on generating a token.",
6262
DefaultFunc: schema.EnvDefaultFunc("SCALR_TOKEN", nil),
6363
},

scalr/resource_scalr_provider_configuration_default.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ func resourceScalrProviderConfigurationDefault() *schema.Resource {
1818
return &schema.Resource{
1919
Description: "Manage defaults of provider configurations for environments in Scalr. Create and destroy." +
2020
"\n\n**Note:** To make the provider configuration default, it must be shared with the specified environment." +
21-
" See the definition of the resource [`scalr_provider_configuration`](provider_configuration.md)" +
21+
" See the definition of the resource [`scalr_provider_configuration`](provider_resource_scalr_provider_configuration)" +
2222
" and attribute `environments` to learn more.",
2323
CreateContext: resourceScalrProviderConfigurationDefaultCreate,
2424
ReadContext: resourceScalrProviderConfigurationDefaultRead,

templates/index.md.tmpl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ slug: "provider_overview"
55
order: 0
66
hidden: false
77
---
8+
# {{.ProviderShortName | title}} Provider
9+
810
The Scalr Terraform provider can be used to manage objects in Scalr with Terraform.
911

1012
Using the Scalr Terraform provider is a best practice as you scale your Terraform and Scalr operations. It is not required, but many customers have a Scalr admin environment and workspace(s), which use the provider to manage all other objects in Scalr.
@@ -40,7 +42,7 @@ If you have tokens stored in files locally, the `~/.terraform.d/credentials.tfrc
4042

4143
As mentioned, a best practice is to use the Scalr Terraform provider to manage objects within Scalr.
4244

43-
If you are using Scalr to execute the Terraform runs that call the Scalr provider, you must override a default token set for each run. The default token has minimal permissions to allow for the run execution, which means the run will fail if you don't set the `SCALR_TOKEN` variable in the workspace. It is recommended to use a [service account](/docs/identity-and-access-management#service-accounts) for the token.
45+
If you are using Scalr to execute the Terraform runs that call the Scalr provider, you must override a default token set for each run. The default token has minimal permissions to allow for the run execution, which means the run will fail if you don't set the `SCALR_TOKEN` variable in the workspace. It is recommended to use a [service account](https://docs.scalr.io/docs/identity-and-access-management#service-accounts) for the token.
4446

4547
![SCALR_TOKEN Variable](https://files.readme.io/2a1d8e3-Screen_Shot_2022-11-28_at_12.19.04_PM.png)
4648

0 commit comments

Comments
 (0)