Skip to content

Commit 0814685

Browse files
sync docs (#518)
Co-authored-by: michaeljguarino <3838088+michaeljguarino@users.noreply.github.com>
1 parent 4ea2ea3 commit 0814685

1 file changed

Lines changed: 141 additions & 0 deletions

File tree

pages/overview/management-api-reference.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
4444
- [Project](#project)
4545
- [Provider](#provider)
4646
- [ScmConnection](#scmconnection)
47+
- [Sentinel](#sentinel)
4748
- [ServiceAccount](#serviceaccount)
4849
- [ServiceContext](#servicecontext)
4950
- [ServiceDeployment](#servicedeployment)
@@ -1472,6 +1473,30 @@ _Appears in:_
14721473

14731474

14741475

1476+
#### Git
1477+
1478+
1479+
1480+
1481+
1482+
1483+
1484+
_Appears in:_
1485+
- [SentinelSpec](#sentinelspec)
1486+
1487+
| Field | Description | Default | Validation |
1488+
| --- | --- | --- | --- |
1489+
| `url` _string_ | URL the url of this repository. | | |
1490+
| `privateKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | PrivateKeyRef reference to a secret containing ssh private key. | | |
1491+
| `passphraseRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | PassphraseRef reference to a secret containing passphrase for the private key. | | |
1492+
| `usernameRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | UsernameRef reference to a secret containing http username. | | |
1493+
| `passwordRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | PasswordRef reference to a secret containing http password. | | |
1494+
| `httpsPath` _string_ | HTTPSPath a manually supplied https path for non standard git setups. | | |
1495+
| `urlFormat` _string_ | URLFormat custom URL format, e.g. \{url\}/tree/\{ref\}/\{folder\}. | | |
1496+
| `connectionId` _string_ | ConnectionID id of a scm connection to use for authentication. | | |
1497+
| `decrypt` _boolean_ | Decrypt whether to run plural crypto on this repo. | | |
1498+
1499+
14751500
#### GitHealth
14761501

14771502
_Underlying type:_ _string_
@@ -3715,6 +3740,122 @@ _Appears in:_
37153740
| `privateKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | | | Optional: \{\} <br /> |
37163741

37173742

3743+
#### Sentinel
3744+
3745+
3746+
3747+
Sentinel is the Schema for the sentinels API
3748+
3749+
3750+
3751+
3752+
3753+
| Field | Description | Default | Validation |
3754+
| --- | --- | --- | --- |
3755+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
3756+
| `kind` _string_ | `Sentinel` | | |
3757+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
3758+
| `spec` _[SentinelSpec](#sentinelspec)_ | | | |
3759+
3760+
3761+
#### SentinelCheck
3762+
3763+
3764+
3765+
3766+
3767+
3768+
3769+
_Appears in:_
3770+
- [SentinelSpec](#sentinelspec)
3771+
3772+
| Field | Description | Default | Validation |
3773+
| --- | --- | --- | --- |
3774+
| `type` _[SentinelCheckType](#sentinelchecktype)_ | Type the type of check to run. | | Enum: [LOG KUBERNETES] <br /> |
3775+
| `name` _string_ | Name the name of the check. | | |
3776+
| `ruleFile` _string_ | RuleFile the rule file to use for this check. | | |
3777+
| `configuration` _[SentinelCheckConfiguration](#sentinelcheckconfiguration)_ | Configuration the configuration to use for this check. | | |
3778+
3779+
3780+
#### SentinelCheckConfiguration
3781+
3782+
3783+
3784+
3785+
3786+
3787+
3788+
_Appears in:_
3789+
- [SentinelCheck](#sentinelcheck)
3790+
3791+
| Field | Description | Default | Validation |
3792+
| --- | --- | --- | --- |
3793+
| `log` _[SentinelCheckLogConfiguration](#sentinelchecklogconfiguration)_ | the log configuration to use for this check | | |
3794+
| `kubernetes` _[SentinelCheckKubernetesConfiguration](#sentinelcheckkubernetesconfiguration)_ | the kubernetes configuration to use for this check | | |
3795+
3796+
3797+
#### SentinelCheckKubernetesConfiguration
3798+
3799+
3800+
3801+
3802+
3803+
3804+
3805+
_Appears in:_
3806+
- [SentinelCheckConfiguration](#sentinelcheckconfiguration)
3807+
3808+
| Field | Description | Default | Validation |
3809+
| --- | --- | --- | --- |
3810+
| `group` _string_ | Group to use when fetching this resource. | | |
3811+
| `version` _string_ | Version the api version to use when fetching this resource. | | |
3812+
| `kind` _string_ | Kind the kind to use when fetching this resource. | | |
3813+
| `name` _string_ | Name to use when fetching this resource. | | |
3814+
| `namespace` _string_ | Namespace to use when fetching this resource | | |
3815+
| `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ClusterRef the cluster to run the query against | | Required: \{\} <br /> |
3816+
3817+
3818+
#### SentinelCheckLogConfiguration
3819+
3820+
3821+
3822+
3823+
3824+
3825+
3826+
_Appears in:_
3827+
- [SentinelCheckConfiguration](#sentinelcheckconfiguration)
3828+
3829+
| Field | Description | Default | Validation |
3830+
| --- | --- | --- | --- |
3831+
| `namespaces` _string array_ | Namespaces the namespaces to run the query against. | | |
3832+
| `query` _string_ | Query a search query this will run against the logs. | | |
3833+
| `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ClusterRef the cluster to run the query against. | | |
3834+
| `duration` _string_ | Duration of the log analysis run. | | |
3835+
| `facets` _object (keys:string, values:string)_ | Facets the log facets to run the query against. | | |
3836+
3837+
3838+
#### SentinelSpec
3839+
3840+
3841+
3842+
SentinelSpec defines the desired state of Sentinel
3843+
3844+
3845+
3846+
_Appears in:_
3847+
- [Sentinel](#sentinel)
3848+
3849+
| Field | Description | Default | Validation |
3850+
| --- | --- | --- | --- |
3851+
| `name` _string_ | Name of this Sentinel.<br />If not provided, the name from Sentinel.ObjectMeta will be used. | | Optional: \{\} <br /> |
3852+
| `description` _string_ | Description provides a human-readable explanation of what this Sentinel. | | |
3853+
| `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | RepositoryRef references a Git repository. | | Optional: \{\} <br /> |
3854+
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references the project this object belongs to, enabling<br />project-scoped organization and access control. | | Optional: \{\} <br /> |
3855+
| `git` _[Git](#git)_ | Git the git repository to use for this sentinel. | | |
3856+
| `checks` _[SentinelCheck](#sentinelcheck) array_ | | | |
3857+
3858+
37183859
#### ServiceAccount
37193860

37203861

0 commit comments

Comments
 (0)