Skip to content

Commit

Permalink
Fix wrong flattened resources in docs (#142)
Browse files Browse the repository at this point in the history
  • Loading branch information
wcmjunior authored Dec 9, 2021
1 parent db4340a commit 87d91b1
Show file tree
Hide file tree
Showing 11 changed files with 68 additions and 21 deletions.
5 changes: 4 additions & 1 deletion docs/data-sources/sidecar_cft_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ data "cyral_sidecar_cft_template" "some_data_source_name" {
* `sidecar_id` - (Required) ID of the sidecar which the template will be generated.
* `log_integration_id` - (Optional) ID of the log integration that will be used by this template.
* `metrics_integration_id` - (Optional) ID of the metrics integration that will be used by this template.
* `aws_configuration` - (Required) AWS parameters for `cloudFormation` deployment method.
* `aws_configuration` - (Required) AWS parameters for `cloudFormation` deployment method. See [aws_configuration](#aws_configuration) below for more details.

### aws_configuration

* `publicly_accessible` - (Required) Defines a public IP and an internet-facing LB if set to `true`.
* `key_name` - (Optional) Key-pair name that will be associated to the sidecar EC2 instances.

Expand Down
10 changes: 8 additions & 2 deletions docs/resources/datamap.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,14 @@ resource "cyral_datamap" "some_resource_name" {
## Argument Reference

* `mapping` = (Required) Block that supports mapping attributes in repos to a given label.
* `label` = (Required) Label given to the data specified in the corresponding list (ex: `your_label_id`)
* `data_location` = (Required) Block to inform a data location set: repository name and attributes specification.
* `label` = (Required) Label given to the data specified in the corresponding list (ex: `your_label_id`). See [Label](#label) below for more details.

### label

* `data_location` = (Required) Block to inform a data location set: repository name and attributes specification. See [Data Location](#data_location) below for more details.

#### data_location

* `repo` = (Required) Name of the repository containing the data as specified through the Cyral management console (ex: `your_repo_name`).
* `attributes` = (Required) List containing the specific locations of the data within the repo, following the pattern `{SCHEMA}.{TABLE}.{ATTRIBUTE}` (ex: `[your_schema_name.your_table_name.your_attr_name]`).
> Note: When referencing data in Dremio repository, please include the complete location in `attributes`, separating spaces by dots. For example, an attribute `my_attr` from table `my_tbl` within space `inner_space` within space `outer_space` would be referenced as `outer_space.inner_space.my_tbl.my_attr`. For more information, please see the [Policy Guide](https://cyral.com/docs/reference/policy/).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_aad.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,13 @@ resource "cyral_integration_idp_aad" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -84,6 +86,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_adfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,13 @@ resource "cyral_integration_idp_adfs" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -85,6 +87,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_forgerock.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,13 @@ resource "cyral_integration_idp_forgerock" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -84,6 +86,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_gsuite.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,13 @@ resource "cyral_integration_idp_gsuite" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -84,6 +86,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,14 @@ resource "cyral_integration_idp_okta" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.
* `draft_alias` - (Optional) An `alias` that uniquely identifies a IdP Integration draft. If set, will delete any correspondent draft and create a new IdP Integration with the same `alias`. Defaults to `""`.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -90,6 +92,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
8 changes: 6 additions & 2 deletions docs/resources/integration_idp_ping_one.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,14 @@ resource "cyral_integration_idp_ping_one" "some_resource_name" {

## Argument Reference

* `samlp` - (Required) It contains the top-level configuration for an identity provider.
* `samlp` - (Required) It contains the top-level configuration for an identity provider. See [samlp](#samlp) below for more details.
* `draft_alias` - (Optional) An `alias` that uniquely identifies a IdP Integration draft. If set, will delete any correspondent draft and create a new IdP Integration with the same `alias`. Defaults to `""`.

### samlp

The `samlp` object supports the following:

* `config` - (Required) The SAML configuration for this IdP Integration.
* `config` - (Required) The SAML configuration for this IdP Integration. See [config](#config) below for more details.
* `provider_id` - (Optional) This is the provider ID of `saml`. Defaults to `saml`.
* `disabled` - (Optional) Disable maps to Keycloak's `enabled` field. Defaults to `false`.
* `first_broker_login_flow_alias` - (Optional) Alias of authentication flow, which is triggered after `First Login` with this identity provider. Term `First Login` means that no Keycloak account is currently linked to the authenticated identity provider account. Defaults to `SAML_First_Broker`.
Expand All @@ -86,6 +88,8 @@ The `samlp` object supports the following:
* `trust_email` - (Optional) If the identity provider supplies an email address this email address will be trusted. If the realm required email validation, users that log in from this identity provider will not have to go through the email verification process. Defaults to `false`.
* `link_only` - (Optional) If true, users cannot log in through this identity provider. They can only link to this identity provider. This is useful if you don't want to allow login from the identity provider, but want to integrate with an identity provider. Defaults to `false`.

#### config

The `config` object supports the following:

* `single_sign_on_service_url` - (Required) The URL that must be used to send authentication requests (SAML AuthnRequest).
Expand Down
18 changes: 14 additions & 4 deletions docs/resources/repository_local_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,45 @@ resource "cyral_repository_local_account" "some_resource_name" {
## Argument Reference

* `repository_id` - (Required) ID of the repository that will be used by the local account.
* `aws_iam` - (Optional) Credential option to set the local account from AWS IAM.
* `aws_secrets_manager` - (Optional) Credential option to set the local account from AWS Secrets Manager.
* `cyral_storage` - (Optional) Credential option to set the local account from Cyral Storage.
* `hashicorp_vault` - (Optional) Credential option to set the local account from Hashicorp Vault.
* `aws_iam` - (Optional) Credential option to set the local account from AWS IAM. See [aws_iam](#aws_iam) below for more details.
* `aws_secrets_manager` - (Optional) Credential option to set the local account from AWS Secrets Manager. See [aws_secrets_manager](#aws_secrets_manager) below for more details.
* `cyral_storage` - (Optional) Credential option to set the local account from Cyral Storage. See [cyral_storage](#cyral_storage) below for more details.
* `hashicorp_vault` - (Optional) Credential option to set the local account from Hashicorp Vault. See [hashicorp_vault](#hashicorp_vault) below for more details.

### aws_iam

The `aws_iam` object supports the following arguments:

* `database_name` - (Optional) Database name that the local account corresponds to.
* `local_account` - (Required) Local account name.
* `role_arn` - (Required) AWS IAM role ARN.

### aws_secrets_manager

The `aws_secrets_manager` object supports the following arguments:

* `database_name` - (Optional) Database name that the local account corresponds to.
* `local_account` - (Required) Local account name.
* `secret_arn` - (Required) ARN of the AWS Secret Manager that stores the credential.

### cyral_storage

The `cyral_storage` object supports the following arguments:

* `database_name` - (Optional) Database name that the local account corresponds to.
* `local_account` - (Required) Local account name.
* `password` - (Required) Local account password.

### hashicorp_vault

The `hashicorp_vault` object supports the following arguments:

* `database_name` - (Optional) Database name that the local account corresponds to.
* `local_account` - (Required) Local account name.
* `path` - (Required) Hashicorp Vault path.

### environment_variable

The `environment_variable` object supports the following arguments:

* `database_name` - (Optional) Database name that the local account corresponds to.
Expand Down
4 changes: 3 additions & 1 deletion docs/resources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ resource "cyral_role" "some_resource_name" {
## Argument Reference

* `name` - (Required) The name of the role.
* `permissions` - (Optional) A block responsible for configuring the role permissions.
* `permissions` - (Optional) A block responsible for configuring the role permissions. See [permissions](#permissions) below for more details.

### permissions

The `permissions` object supports the following:

Expand Down
4 changes: 3 additions & 1 deletion docs/resources/role_sso_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ resource "cyral_role_sso_groups" "some_role_sso_groups" {
## Argument Reference

* `role_id` - (Required) The ID of the role resource that will be configured.
* `sso_group` - (Required) A block responsible for mapping an SSO group to a role.
* `sso_group` - (Required) A block responsible for mapping an SSO group to a role. See [sso_group](#sso_group) below for more details.

### sso_group

The `sso_group` object supports the following:

Expand Down

0 comments on commit 87d91b1

Please sign in to comment.