vyra.sh API Reference
Resource Types
Example Resources
API Resources
Cell
Cell is the Schema for the cells API
API Version: vyra.sh/v1alpha1
Kind: Cell
| Field | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | vyra.sh/v1alpha1 | true |
| kind | string | Cell | true |
| metadata | object | Standard object metadata | true |
| spec | object | spec defines the desired state of Cell | true |
| status | object | status defines the observed state of Cell | false |
Cell.spec
spec defines the desired state of Cell
| Field | Type | Description | Required |
|---|---|---|---|
| tenancy | object | TenancySpec defines the tenancy specifications for the Cell. | false |
| triggerOperator | object | TriggerOperator defines the specifications for the Trigger Operator within the Cell. | false |
Cell.spec.tenancy
TenancySpec defines the tenancy specifications for the Cell.
| Field | Type | Description | Required |
|---|---|---|---|
| mode | enum | Mode defines the tenancy mode for the Cell. Possible values are "shared" and "dedicated". Default is "shared". (Enum: "shared", "dedicated") | false |
Cell.spec.triggerOperator
TriggerOperator defines the specifications for the Trigger Operator within the Cell.
| Field | Type | Description | Required |
|---|---|---|---|
| version | string | Version defines the version of the operator to deploy. | true |
Cell.status
status defines the observed state of Cell
| Field | Type | Description | Required |
|---|---|---|---|
| conditions | []object | The status of each condition is one of True, False, or Unknown. | false |
| readyTriggerOperator | boolean | ReadyTriggerOperator indicates whether the TriggerOperator in the Cell is ready. | false |
Cell.status.conditions[]
Condition contains details for one aspect of the current state of this API Resource.
| Field | Type | Description | Required |
|---|---|---|---|
| observedGeneration | integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. | false |
| reason | string | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. | true |
| status | enum | status of the condition, one of True, False, Unknown. (Enum: "True", "False", "Unknown") | true |
| type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
| lastTransitionTime | string | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | true |
| message | string | message is a human readable message indicating details about the transition. This may be an empty string. | true |
Examples
Example: Cell
yaml
apiVersion: vyra.sh/v1alpha1
kind: Cell
metadata:
labels:
app.kubernetes.io/name: soar-operator
app.kubernetes.io/managed-by: kustomize
name: cell-sample
namespace: vyra-cell-sample
spec:
tenancy:
mode: shared
triggerOperator:
version: v0.0.2