From 4ec1b69d16a9e0f36c9653ace4d5be58f1618424 Mon Sep 17 00:00:00 2001 From: Oved Ourfali Date: Mon, 15 Nov 2021 16:28:01 +0200 Subject: [PATCH] adding generated docs folder --- docs/data-sources/cloud_providers.md | 26 ++++++++++++ docs/index.md | 28 +++++++++++++ docs/resources/cluster.md | 43 +++++++++++++++++++ docs/resources/identity_provider.md | 63 ++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+) create mode 100644 docs/data-sources/cloud_providers.md create mode 100644 docs/index.md create mode 100644 docs/resources/cluster.md create mode 100644 docs/resources/identity_provider.md diff --git a/docs/data-sources/cloud_providers.md b/docs/data-sources/cloud_providers.md new file mode 100644 index 0000000..4a6868b --- /dev/null +++ b/docs/data-sources/cloud_providers.md @@ -0,0 +1,26 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "ocm_cloud_providers Data Source - terraform-provider-ocm" +subcategory: "" +description: |- + List of cloud providers. +--- + +# ocm_cloud_providers (Data Source) + +List of cloud providers. + + + + +## Schema + +### Optional + +- **id** (String) The ID of this resource. + +### Read-Only + +- **ids** (Set of String) Set of identifiers of the cloud providers. + + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9bb9148 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,28 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "ocm Provider" +subcategory: "" +description: |- + +--- + +# ocm Provider + + + + + + +## Schema + +### Optional + +- **client_id** (String) OpenID client identifier. +- **client_secret** (String, Sensitive) OpenID client secret. +- **insecure** (Boolean) When set to 'true' enables insecure communication with the server. This disables verification of TLS certificates and host names and it isn't recommended for production environments. +- **password** (String, Sensitive) User password. +- **token** (String, Sensitive) Access or refresh token. +- **token_url** (String) OpenID token URL. +- **trusted_cas** (String) PEM encoded certificates of authorities that will be trusted. If this isn't explicitly specified then the provider will trust the certificate authorities trusted by default by the system. +- **url** (String) URL of the API server. +- **user** (String) User name. diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md new file mode 100644 index 0000000..b326951 --- /dev/null +++ b/docs/resources/cluster.md @@ -0,0 +1,43 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "ocm_cluster Resource - terraform-provider-ocm" +subcategory: "" +description: |- + Creates an OpenShift managed cluster. +--- + +# ocm_cluster (Resource) + +Creates an OpenShift managed cluster. + + + + +## Schema + +### Required + +- **cloud_provider** (String) Cloud provider identifier, for example 'aws'. +- **cloud_region** (String) Cloud region identifier, for example 'us-east-1'. +- **name** (String) Name of the cluster. + +### Optional + +- **id** (String) The ID of this resource. +- **multi_az** (Boolean) Indicates if the cluster should be deployed to multiple availability zones. +- **properties** (Map of String) User defined properties. +- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- **wait** (Boolean) Wait till the cluster is ready. + +### Read-Only + +- **state** (Map of String) State of the cluster. + + +### Nested Schema for `timeouts` + +Optional: + +- **create** (String) + + diff --git a/docs/resources/identity_provider.md b/docs/resources/identity_provider.md new file mode 100644 index 0000000..05f4b41 --- /dev/null +++ b/docs/resources/identity_provider.md @@ -0,0 +1,63 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "ocm_identity_provider Resource - terraform-provider-ocm" +subcategory: "" +description: |- + Creates an identity provider. +--- + +# ocm_identity_provider (Resource) + +Creates an identity provider. + + + + +## Schema + +### Required + +- **cluster_id** (String) Identifier of the cluster. +- **name** (String) Name of the identity provider. + +### Optional + +- **htpasswd** (Block List, Max: 1) Details for the 'htpassw' identity provider. (see [below for nested schema](#nestedblock--htpasswd)) +- **id** (String) The ID of this resource. +- **ldap** (Block List, Max: 1) Details for the LDAP identity provider. (see [below for nested schema](#nestedblock--ldap)) + + +### Nested Schema for `htpasswd` + +Required: + +- **password** (String, Sensitive) User password. +- **user** (String) User name. + + + +### Nested Schema for `ldap` + +Required: + +- **attributes** (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--ldap--attributes)) +- **bind_dn** (String) +- **bind_password** (String) +- **url** (String) + +Optional: + +- **ca** (String) +- **insecure** (Boolean) + + +### Nested Schema for `ldap.attributes` + +Optional: + +- **email** (List of String) +- **id** (List of String) The ID of this resource. +- **name** (List of String) +- **preferred_username** (List of String) + +