Skip to content

Commit

Permalink
Upate terraform schema and docs and crds.
Browse files Browse the repository at this point in the history
  • Loading branch information
Joerger committed Oct 8, 2024
1 parent 6abd08b commit 612bc4f
Show file tree
Hide file tree
Showing 7 changed files with 175 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,13 @@ resource, which you can apply after installing the Teleport Kubernetes operator.

|Field|Type|Description|
|---|---|---|
|cert|string|Cert is the identity provider certificate PEM. IDP signs `<Response>` responses using this certificate.|
|enabled|boolean|Enabled specified whether this SAML connector supports MFA checks. Defaults to false.|
|entity_descriptor|string|EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements.|
|entity_descriptor|string|EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements. Usually set from EntityDescriptorUrl.|
|entity_descriptor_url|string|EntityDescriptorUrl is a URL that supplies a configuration XML.|
|force_authn|string or integer|ForceAuthn specified whether re-authentication should be forced for MFA checks. UNSPECIFIED is treated as YES to always re-authentication for MFA checks. This should only be set to NO if the IdP is setup to perform MFA checks on top of active user sessions. Can be either the string or the integer representation of each option.|
|issuer|string|Issuer is the identity provider issuer. Usually set from EntityDescriptor.|
|sso|string|SSO is the URL of the identity provider's SSO service. Usually set from EntityDescriptor.|

### spec.signing_key_pair

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,13 @@ Optional:

Optional:

- `cert` (String) Cert is the identity provider certificate PEM. IDP signs `<Response>` responses using this certificate.
- `enabled` (Boolean) Enabled specified whether this SAML connector supports MFA checks. Defaults to false.
- `entity_descriptor` (String) EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements.
- `entity_descriptor` (String) EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements. Usually set from EntityDescriptorUrl.
- `entity_descriptor_url` (String) EntityDescriptorUrl is a URL that supplies a configuration XML.
- `force_authn` (Number) ForceAuthn specified whether re-authentication should be forced for MFA checks. UNSPECIFIED is treated as YES to always re-authentication for MFA checks. This should only be set to NO if the IdP is setup to perform MFA checks on top of active user sessions.
- `issuer` (String) Issuer is the identity provider issuer. Usually set from EntityDescriptor.
- `sso` (String) SSO is the URL of the identity provider's SSO service. Usually set from EntityDescriptor.


### Nested Schema for `spec.signing_key_pair`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,13 @@ Optional:

Optional:

- `cert` (String) Cert is the identity provider certificate PEM. IDP signs `<Response>` responses using this certificate.
- `enabled` (Boolean) Enabled specified whether this SAML connector supports MFA checks. Defaults to false.
- `entity_descriptor` (String) EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements.
- `entity_descriptor` (String) EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements. Usually set from EntityDescriptorUrl.
- `entity_descriptor_url` (String) EntityDescriptorUrl is a URL that supplies a configuration XML.
- `force_authn` (Number) ForceAuthn specified whether re-authentication should be forced for MFA checks. UNSPECIFIED is treated as YES to always re-authentication for MFA checks. This should only be set to NO if the IdP is setup to perform MFA checks on top of active user sessions.
- `issuer` (String) Issuer is the identity provider issuer. Usually set from EntityDescriptor.
- `sso` (String) SSO is the URL of the identity provider's SSO service. Usually set from EntityDescriptor.


### Nested Schema for `spec.signing_key_pair`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,19 @@ spec:
through this auth connector.
nullable: true
properties:
cert:
description: Cert is the identity provider certificate PEM. IDP
signs `<Response>` responses using this certificate.
type: string
enabled:
description: Enabled specified whether this SAML connector supports
MFA checks. Defaults to false.
type: boolean
entity_descriptor:
description: EntityDescriptor is XML with descriptor. It can be
used to supply configuration parameters in one XML file rather
than supplying them in the individual elements.
than supplying them in the individual elements. Usually set
from EntityDescriptorUrl.
type: string
entity_descriptor_url:
description: EntityDescriptorUrl is a URL that supplies a configuration
Expand All @@ -147,6 +152,14 @@ spec:
NO if the IdP is setup to perform MFA checks on top of active
user sessions.
x-kubernetes-int-or-string: true
issuer:
description: Issuer is the identity provider issuer. Usually set
from EntityDescriptor.
type: string
sso:
description: SSO is the URL of the identity provider's SSO service.
Usually set from EntityDescriptor.
type: string
type: object
provider:
description: Provider is the external identity provider.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,19 @@ spec:
through this auth connector.
nullable: true
properties:
cert:
description: Cert is the identity provider certificate PEM. IDP
signs `<Response>` responses using this certificate.
type: string
enabled:
description: Enabled specified whether this SAML connector supports
MFA checks. Defaults to false.
type: boolean
entity_descriptor:
description: EntityDescriptor is XML with descriptor. It can be
used to supply configuration parameters in one XML file rather
than supplying them in the individual elements.
than supplying them in the individual elements. Usually set
from EntityDescriptorUrl.
type: string
entity_descriptor_url:
description: EntityDescriptorUrl is a URL that supplies a configuration
Expand All @@ -147,6 +152,14 @@ spec:
NO if the IdP is setup to perform MFA checks on top of active
user sessions.
x-kubernetes-int-or-string: true
issuer:
description: Issuer is the identity provider issuer. Usually set
from EntityDescriptor.
type: string
sso:
description: SSO is the URL of the identity provider's SSO service.
Usually set from EntityDescriptor.
type: string
type: object
provider:
description: Provider is the external identity provider.
Expand Down
4 changes: 2 additions & 2 deletions integrations/terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Please, refer to [official documentation](https://goteleport.com/docs/admin-guid
## Development

1. Install [`protobuf`](https://grpc.io/docs/protoc-installation/).
2. Install [`protoc-gen-terraform`](https://github.com/gravitational/protoc-gen-terraform).
2. Install [`protoc-gen-terraform`](https://github.com/gravitational/protoc-gen-terraform) @v2.2.0.

```go install github.com/gravitational/protoc-gen-terraform@main```
```go install github.com/gravitational/protoc-gen-terraform@08768262d29336b8ae0915ef41bb6d9768518c66```

3. Install [`Terraform`](https://learn.hashicorp.com/tutorials/terraform/install-cli) v1.1.0+. Alternatively, you can use [`tfenv`](https://github.com/tfutils/tfenv). Please note that on Mac M1 you need to specify `TFENV_ARCH` (ex: `TFENV_ARCH=arm64 tfenv install 1.1.6`).

Expand Down
134 changes: 133 additions & 1 deletion integrations/terraform/tfschema/types_terraform.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 612bc4f

Please sign in to comment.