Skip to content

Commit bab017b

Browse files
sync docs (#496)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 96cf69e commit bab017b

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

pages/overview/management-api-reference.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
1919
- [ComplianceReportGenerator](#compliancereportgenerator)
2020
- [CustomStackRun](#customstackrun)
2121
- [DeploymentSettings](#deploymentsettings)
22+
- [FederatedCredential](#federatedcredential)
2223
- [Flow](#flow)
2324
- [GeneratedSecret](#generatedsecret)
2425
- [GitRepository](#gitrepository)
@@ -1110,6 +1111,43 @@ _Appears in:_
11101111

11111112

11121113

1114+
#### FederatedCredential
1115+
1116+
1117+
1118+
FederatedCredential is a way to authenticate users from an external identity provider.
1119+
1120+
1121+
1122+
1123+
1124+
| Field | Description | Default | Validation |
1125+
| --- | --- | --- | --- |
1126+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
1127+
| `kind` _string_ | `FederatedCredential` | | |
1128+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
1129+
| `spec` _[FederatedCredentialSpec](#federatedcredentialspec)_ | | | |
1130+
1131+
1132+
#### FederatedCredentialSpec
1133+
1134+
1135+
1136+
FederatedCredentialSpec defines the desired state of FederatedCredential.
1137+
1138+
1139+
1140+
_Appears in:_
1141+
- [FederatedCredential](#federatedcredential)
1142+
1143+
| Field | Description | Default | Validation |
1144+
| --- | --- | --- | --- |
1145+
| `issuer` _string_ | Issuer is the URL of the identity provider that issues the tokens. | | Required: {} <br /> |
1146+
| `scopes` _string array_ | Scopes are the scopes that the credential will request from the identity provider. | | Optional: {} <br /> |
1147+
| `claimsLike` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | ClaimsLike is a JSON expression that matches the claims in the token.<br />All the value strings should be a valid regular expression.<br /><br />Example:<br /> ...<br /> claimsLike:<br /> sub: "repo:myaccount/myrepo:ref:refs/heads/.*" | | Optional: {} <br /> |
1148+
| `user` _string_ | User is the user email address that will be authenticated by this credential. | | Required: {} <br /> |
1149+
1150+
11131151
#### Flow
11141152

11151153

@@ -1360,6 +1398,7 @@ _Appears in:_
13601398
| --- | --- | --- | --- |
13611399
| `tags` _object (keys:string, values:string)_ | Tags a set of tags to select clusters for this global service | | Optional: {} <br /> |
13621400
| `reparent` _boolean_ | Whether you'd want this global service to take ownership of existing Plural services | | Optional: {} <br /> |
1401+
| `interval` _string_ | Interval specifies the interval at which the global service will be reconciled, default is 10m | | Optional: {} <br /> |
13631402
| `cascade` _[Cascade](#cascade)_ | Cascade deletion options for this global service | | Optional: {} <br /> |
13641403
| `context` _[TemplateContext](#templatecontext)_ | Context to be used for dynamic template overrides of things like helm chart, version or values files | | Optional: {} <br /> |
13651404
| `distro` _[ClusterDistro](#clusterdistro)_ | Distro of kubernetes this cluster is running | | Enum: [GENERIC EKS AKS GKE RKE K3S] <br />Optional: {} <br /> |
@@ -1610,6 +1649,7 @@ _Appears in:_
16101649
| --- | --- | --- | --- |
16111650
| `name` _string_ | Name of this Stack. If not provided InfrastructureStack's own name from InfrastructureStack.ObjectMeta will be used. | | Optional: {} <br /> |
16121651
| `type` _[StackType](#stacktype)_ | Type specifies the tool to use to apply it | | Enum: [TERRAFORM ANSIBLE CUSTOM] <br />Required: {} <br /> |
1652+
| `interval` _string_ | Interval specifies the interval at which the stack will be reconciled, default is 5m | | Optional: {} <br /> |
16131653
| `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | RepositoryRef to source IaC from | | Required: {} <br /> |
16141654
| `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Required: {} <br /> |
16151655
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references project this stack belongs to.<br />If not provided, it will use the default project. | | Optional: {} <br /> |

0 commit comments

Comments
 (0)