You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/overview/management-api-reference.md
+141Lines changed: 141 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
44
44
-[Project](#project)
45
45
-[Provider](#provider)
46
46
-[ScmConnection](#scmconnection)
47
+
-[Sentinel](#sentinel)
47
48
-[ServiceAccount](#serviceaccount)
48
49
-[ServiceContext](#servicecontext)
49
50
-[ServiceDeployment](#servicedeployment)
@@ -1472,6 +1473,30 @@ _Appears in:_
1472
1473
1473
1474
1474
1475
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. |||
|`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 |||
|`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 /> |
|`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. |||
0 commit comments