Skip to content

Commit

Permalink
Update provider documents with updated descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilsbhat committed Feb 19, 2023
1 parent da9ae94 commit a6a7da8
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 18 deletions.
8 changes: 4 additions & 4 deletions docs/data-sources/auth_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ description: |-

### Required

- `profile_id` (String) The identifier of the elastic agent profile.
- `profile_id` (String) The identifier of the authorization configuration.

### Optional

- `allow_only_known_users_to_login` (Boolean) Allow only those users to login who have explicitly been added by an administrator.
- `etag` (String) Etag used to track the authorisation configuration.
- `plugin_id` (String) The plugin identifier of the cluster profile.
- `properties` (Block List) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--properties))
- `etag` (String) Etag used to track the authorization configuration.
- `plugin_id` (String) The plugin identifier of the authorization plugin.
- `properties` (Block List) The list of configuration properties that represent the configuration of this authorization configuration. (see [below for nested schema](#nestedblock--properties))

### Read-Only

Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/config_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ description: |-

### Required

- `profile_id` (String) The identifier of the elastic agent profile.
- `profile_id` (String) The identifier of the config repository.

### Optional

- `configuration` (Block List) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--configuration))
- `etag` (String) Etag used to track the plugin settings
- `plugin_id` (String) The plugin identifier of the cluster profile.
- `configuration` (Block List) The list of properties (key-value pairs) to be provided for using the plugin. (see [below for nested schema](#nestedblock--configuration))
- `etag` (String) Etag used to track the config repository.
- `plugin_id` (String) The name of the config repo plugin.

### Read-Only

Expand All @@ -38,7 +38,7 @@ Optional:

- `encrypted_value` (String) The encrypted value of the property
- `is_secure` (Boolean) Specify whether the given property is secure or not. If true and encrypted_value is not specified, GoCD will store the value in encrypted format.
- `key` (String) the name of the property key.
- `key` (String) The name of the property key.
- `value` (String) The value of the property


Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/plugin_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ description: |-
### Optional

- `configuration` (Block List) List of configuration required to configure the plugin settings. (see [below for nested schema](#nestedblock--configuration))
- `etag` (String) Etag used to track the cluster profile
- `plugin_id` (String) The plugin identifier of the cluster profile.
- `etag` (String) Etag used to track the plugin settings.
- `plugin_id` (String) The unique identifier of the plugin.

### Read-Only

Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,14 @@ provider "gocd" {
<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `username` (String) username to be used while connecting with GoCD

### Optional

- `auth_token` (String) bearer-token to be used while connecting with GoCD (API: https://api.gocd.org/current/#access-tokens, UI: https://docs.gocd.org/current/configuration/access_tokens.html) cannot co-exist with password based auth.
- `base_url` (String) base url of GoCD server, with which this terraform provider will with (https://gocd.myself.com/go)
- `ca_file` (String) CA file contents, to be used while connecting to GoCD server when CA based auth is enabled
- `loglevel` (String) loglevel to be set for the api calls made to GoCD
- `password` (String) password to be used while connecting with GoCD
- `username` (String) username to be used while connecting with GoCD
6 changes: 3 additions & 3 deletions docs/resources/config_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ description: |-

- `configuration` (Block Set, Min: 1) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--configuration))
- `material` (Block Set, Min: 1) The material to be used by the config repo. (see [below for nested schema](#nestedblock--material))
- `plugin_id` (String) The plugin identifier of the cluster profile.
- `profile_id` (String) The identifier of the elastic agent profile.
- `plugin_id` (String) The name of the config repo plugin.
- `profile_id` (String) The identifier of the config repository.

### Optional

- `rules` (List of Map of String) The list of rules, which allows restricting the entities that the config repo can refer to.

### Read-Only

- `etag` (String) Etag used to track the plugin settings
- `etag` (String) Etag used to track the config repository.
- `id` (String) The ID of this resource.

<a id="nestedblock--configuration"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/plugin_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: |-
### Required

- `plugin_configurations` (Block Set, Min: 1) list of configurations to be applied to GoCD plugin (see [below for nested schema](#nestedblock--plugin_configurations))
- `plugin_id` (String) id of the GoCD plugin to which the settings to be applied
- `plugin_id` (String) ID of the GoCD plugin to which the settings to be applied

### Read-Only

Expand All @@ -30,7 +30,7 @@ description: |-

Required:

- `key` (String) the name of the property key.
- `key` (String) The name of the property key.

Optional:

Expand Down
2 changes: 1 addition & 1 deletion examples/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ terraform {
provider "gocd" {
base_url = "http://localhost:8153/go"
username = "admin"
password = "admin"
// password = "admin"
auth_token = "d8fccbc997d04e917b1490af8e7bf46290ab8c99"
loglevel = "debug"
}

0 comments on commit a6a7da8

Please sign in to comment.