Skip to content

Commit 628805b

Browse files
Update docs for operator (#313)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 1862cf4 commit 628805b

File tree

1 file changed

+28
-6
lines changed
  • pages/deployments/operator

1 file changed

+28
-6
lines changed

pages/deployments/operator/api.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,27 @@ _Appears in:_
468468
| `args` _string array_ | | | Optional: {} <br /> |
469469
| `env` _[Env](#env) array_ | | | Optional: {} <br /> |
470470
| `envFrom` _[EnvFrom](#envfrom) array_ | | | Optional: {} <br /> |
471+
| `resources` _[ContainerResources](#containerresources)_ | | | Optional: {} <br /> |
472+
473+
474+
475+
476+
#### ContainerResources
477+
478+
479+
480+
481+
482+
483+
484+
_Appears in:_
485+
- [Container](#container)
486+
- [JobSpec](#jobspec)
487+
488+
| Field | Description | Default | Validation |
489+
| --- | --- | --- | --- |
490+
| `requests` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {} <br /> |
491+
| `limits` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {} <br /> |
471492

472493

473494
#### CustomRunStep
@@ -980,6 +1001,7 @@ _Appears in:_
9801001
| `annotations` _object (keys:string, values:string)_ | | | Optional: {} <br /> |
9811002
| `serviceAccount` _string_ | | | Optional: {} <br />Type: string <br /> |
9821003
| `raw` _[JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#jobspec-v1-batch)_ | Raw can be used if you'd rather define the job spec via straight Kubernetes manifest file. | | Optional: {} <br /> |
1004+
| `resources` _[ContainerResources](#containerresources)_ | Resource specification that overrides implicit container resources when containers are not directly configured. | | Optional: {} <br /> |
9831005

9841006

9851007
#### ManagedNamespace
@@ -1260,7 +1282,7 @@ _Appears in:_
12601282
| Field | Description | Default | Validation |
12611283
| --- | --- | --- | --- |
12621284
| `type` _[ObserverActionType](#observeractiontype)_ | | | Enum: [PIPELINE PR] <br />Type: string <br /> |
1263-
| `configuration` _[ObserverConfiguration](#observerconfiguration)_ | | | |
1285+
| `configuration` _[ObserverConfiguration](#observerconfiguration)_ | The configuration for the given action, relative to its current Type | | |
12641286

12651287

12661288
#### ObserverConfiguration
@@ -1348,7 +1370,7 @@ _Appears in:_
13481370
| Field | Description | Default | Validation |
13491371
| --- | --- | --- | --- |
13501372
| `pipelineRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | PipelineRef references to Pipeline. | | |
1351-
| `context` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | | | |
1373+
| `context` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | Context is a templated context that will become the PipelineContext applied to the given pipeline, use `$value` to interpolate the observed value | | |
13521374

13531375

13541376
#### ObserverPrAction
@@ -1367,7 +1389,7 @@ _Appears in:_
13671389
| `prAutomationRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | PrAutomationRef references to PR automation. | | |
13681390
| `repository` _string_ | | | Optional: {} <br /> |
13691391
| `branchTemplate` _string_ | BranchTemplate a template to use for the created branch, use $value to interject the observed value | | |
1370-
| `context` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | Context is a ObserverPrAction context | | |
1392+
| `context` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | Context is a templated context that will become the context applied to the given PR Automation, use `$value` to interpolate the observed value | | |
13711393

13721394

13731395
#### ObserverSpec
@@ -1384,9 +1406,9 @@ _Appears in:_
13841406
| Field | Description | Default | Validation |
13851407
| --- | --- | --- | --- |
13861408
| `name` _string_ | the name of this observer, if not provided Observer's own name from Observer.ObjectMeta will be used. | | Optional: {} <br /> |
1387-
| `crontab` _string_ | | | |
1388-
| `target` _[ObserverTarget](#observertarget)_ | | | |
1389-
| `actions` _[ObserverAction](#observeraction) array_ | | | |
1409+
| `crontab` _string_ | The crontab you will poll the given Target with | | |
1410+
| `target` _[ObserverTarget](#observertarget)_ | The target object to poll, triggering the list of Actions w/ the discovered value | | |
1411+
| `actions` _[ObserverAction](#observeraction) array_ | A list of predefined actions to take if a new Target is discovered in the last poll loop | | |
13901412
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references project this observer belongs to.<br />If not provided, it will use the default project. | | Optional: {} <br /> |
13911413

13921414

0 commit comments

Comments
 (0)