Red Hat SummitChapter 21. DeploymentService
21.1. CountDeployments
GET /v1/deploymentscount
CountDeployments returns the number of deployments.
21.1.1. Description
21.1.2. Parameters
21.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
21.1.3. Return Type
21.1.4. Content Type
- application/json
21.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.6. Samples
21.1.7. Common object reference
21.1.7.1. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.1.7.1.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.1.7.2. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.1.7.3. V1CountDeploymentsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| count | Integer | int32 |
21.2. ListDeployments
GET /v1/deployments
ListDeployments returns the list of deployments.
21.2.1. Description
21.2.2. Parameters
21.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
21.2.3. Return Type
21.2.4. Content Type
- application/json
21.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.2.6. Samples
21.2.7. Common object reference
21.2.7.1. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.2.7.1.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.2.7.2. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.2.7.3. StorageListDeployment
Next available tag: 9| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| hash | String | uint64 | |||
| name | String | ||||
| cluster | String | ||||
| clusterId | String | ||||
| namespace | String | ||||
| created | Date | date-time | |||
| priority | String | int64 |
21.2.7.4. V1ListDeploymentsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| deployments | List of StorageListDeployment |
21.3. GetDeployment
GET /v1/deployments/{id}
GetDeployment returns a deployment given its ID.
21.3.1. Description
21.3.2. Parameters
21.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
21.3.3. Return Type
21.3.4. Content Type
- application/json
21.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.3.6. Samples
21.3.7. Common object reference
21.3.7.1. ContainerConfigEnvironmentConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| value | String | ||||
| envVarSource | UNSET, RAW, SECRET_KEY, CONFIG_MAP_KEY, FIELD, RESOURCE_FIELD, UNKNOWN, |
21.3.7.2. EnvironmentConfigEnvVarSource
For any update to EnvVarSource, please also update 'ui/src/messages/common.js'| Enum Values |
|---|
| UNSET |
| RAW |
| SECRET_KEY |
| CONFIG_MAP_KEY |
| FIELD |
| RESOURCE_FIELD |
| UNKNOWN |
21.3.7.3. PortConfigExposureInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| level | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| serviceName | String | ||||
| serviceId | String | ||||
| serviceClusterIp | String | ||||
| servicePort | Integer | int32 | |||
| nodePort | Integer | int32 | |||
| externalIps |
List of | ||||
| externalHostnames |
List of |
21.3.7.4. PortConfigExposureLevel
| Enum Values |
|---|
| UNSET |
| EXTERNAL |
| NODE |
| INTERNAL |
| HOST |
| ROUTE |
21.3.7.5. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.3.7.5.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.3.7.6. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.3.7.7. SeccompProfileProfileType
| Enum Values |
|---|
| UNCONFINED |
| RUNTIME_DEFAULT |
| LOCALHOST |
21.3.7.8. SecurityContextSELinux
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| user | String | ||||
| role | String | ||||
| type | String | ||||
| level | String |
21.3.7.9. SecurityContextSeccompProfile
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| type | UNCONFINED, RUNTIME_DEFAULT, LOCALHOST, | ||||
| localhostProfile | String |
21.3.7.10. StorageContainer
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| config | |||||
| image | |||||
| securityContext | |||||
| volumes | List of StorageVolume | ||||
| ports | List of StoragePortConfig | ||||
| secrets | List of StorageEmbeddedSecret | ||||
| resources | |||||
| name | String | ||||
| livenessProbe | |||||
| readinessProbe |
21.3.7.11. StorageContainerConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| env | List of ContainerConfigEnvironmentConfig | ||||
| command |
List of | ||||
| args |
List of | ||||
| directory | String | ||||
| user | String | ||||
| uid | String | int64 | |||
| appArmorProfile | String |
21.3.7.12. StorageContainerImage
Next tag: 12| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | |||||
| notPullable | Boolean | ||||
| isClusterLocal | Boolean |
21.3.7.13. StorageDeployment
Next available tag: 35| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| hash | String | uint64 | |||
| type | String | ||||
| namespace | String | ||||
| namespaceId | String | ||||
| orchestratorComponent | Boolean | ||||
| replicas | String | int64 | |||
| labels |
Map of | ||||
| podLabels |
Map of | ||||
| labelSelector | |||||
| created | Date | date-time | |||
| clusterId | String | ||||
| clusterName | String | ||||
| containers | List of StorageContainer | ||||
| annotations |
Map of | ||||
| priority | String | int64 | |||
| inactive | Boolean | ||||
| imagePullSecrets |
List of | ||||
| serviceAccount | String | ||||
| serviceAccountPermissionLevel | UNSET, NONE, DEFAULT, ELEVATED_IN_NAMESPACE, ELEVATED_CLUSTER_WIDE, CLUSTER_ADMIN, | ||||
| automountServiceAccountToken | Boolean | ||||
| hostNetwork | Boolean | ||||
| hostPid | Boolean | ||||
| hostIpc | Boolean | ||||
| runtimeClass | String | ||||
| tolerations | List of StorageToleration | ||||
| ports | List of StoragePortConfig | ||||
| stateTimestamp | String | int64 | |||
| riskScore | Float | float |
21.3.7.14. StorageEmbeddedSecret
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| path | String |
21.3.7.15. StorageImageName
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| registry | String | ||||
| remote | String | ||||
| tag | String | ||||
| fullName | String |
21.3.7.16. StorageLabelSelector
Label selector components are joined with logical AND, see https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| matchLabels |
Map of | This is actually a oneof, but we can’t make it one due to backwards compatibility constraints. | |||
| requirements | List of StorageLabelSelectorRequirement |
21.3.7.17. StorageLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
21.3.7.18. StorageLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
21.3.7.19. StorageLivenessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.3.7.20. StoragePermissionLevel
For any update to PermissionLevel, also update: - pkg/searchbasedpolicies/builders/k8s_rbac.go - ui/src/messages/common.js| Enum Values |
|---|
| UNSET |
| NONE |
| DEFAULT |
| ELEVATED_IN_NAMESPACE |
| ELEVATED_CLUSTER_WIDE |
| CLUSTER_ADMIN |
21.3.7.21. StoragePortConfig
Next Available Tag: 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| containerPort | Integer | int32 | |||
| protocol | String | ||||
| exposure | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| exposedPort | Integer | int32 | |||
| exposureInfos | List of PortConfigExposureInfo |
21.3.7.22. StorageReadinessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.3.7.23. StorageResources
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| cpuCoresRequest | Float | float | |||
| cpuCoresLimit | Float | float | |||
| memoryMbRequest | Float | float | |||
| memoryMbLimit | Float | float |
21.3.7.24. StorageSecurityContext
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| privileged | Boolean | ||||
| selinux | |||||
| dropCapabilities |
List of | ||||
| addCapabilities |
List of | ||||
| readOnlyRootFilesystem | Boolean | ||||
| seccompProfile | |||||
| allowPrivilegeEscalation | Boolean |
21.3.7.25. StorageTaintEffect
| Enum Values |
|---|
| UNKNOWN_TAINT_EFFECT |
| NO_SCHEDULE_TAINT_EFFECT |
| PREFER_NO_SCHEDULE_TAINT_EFFECT |
| NO_EXECUTE_TAINT_EFFECT |
21.3.7.26. StorageToleration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| operator | TOLERATION_OPERATION_UNKNOWN, TOLERATION_OPERATOR_EXISTS, TOLERATION_OPERATOR_EQUAL, | ||||
| value | String | ||||
| taintEffect | UNKNOWN_TAINT_EFFECT, NO_SCHEDULE_TAINT_EFFECT, PREFER_NO_SCHEDULE_TAINT_EFFECT, NO_EXECUTE_TAINT_EFFECT, |
21.3.7.27. StorageTolerationOperator
| Enum Values |
|---|
| TOLERATION_OPERATION_UNKNOWN |
| TOLERATION_OPERATOR_EXISTS |
| TOLERATION_OPERATOR_EQUAL |
21.3.7.28. StorageVolume
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| source | String | ||||
| destination | String | ||||
| readOnly | Boolean | ||||
| type | String | ||||
| mountPropagation | NONE, HOST_TO_CONTAINER, BIDIRECTIONAL, |
21.3.7.29. VolumeMountPropagation
| Enum Values |
|---|
| NONE |
| HOST_TO_CONTAINER |
| BIDIRECTIONAL |
21.4. GetLabels
GET /v1/deployments/metadata/labels
GetLabels returns the labels used by deployments.
21.4.1. Description
21.4.2. Parameters
21.4.3. Return Type
21.4.4. Content Type
- application/json
21.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.4.6. Samples
21.4.7. Common object reference
21.4.7.1. DeploymentLabelsResponseLabelValues
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| values |
List of |
21.4.7.2. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.4.7.2.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.4.7.3. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.4.7.4. V1DeploymentLabelsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| labels | |||||
| values |
List of |
21.5. ListDeploymentsWithProcessInfo
GET /v1/deploymentswithprocessinfo
ListDeploymentsWithProcessInfo returns the list of deployments with process information.
21.5.1. Description
21.5.2. Parameters
21.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
21.5.3. Return Type
21.5.4. Content Type
- application/json
21.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.5.6. Samples
21.5.7. Common object reference
21.5.7.1. ContainerNameAndBaselineStatusBaselineStatus
| Enum Values |
|---|
| INVALID |
| NOT_GENERATED |
| UNLOCKED |
| LOCKED |
21.5.7.2. ListDeploymentsWithProcessInfoResponseDeploymentWithProcessInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| deployment | |||||
| baselineStatuses |
21.5.7.3. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.5.7.3.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.5.7.4. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.5.7.5. StorageContainerNameAndBaselineStatus
ContainerNameAndBaselineStatus represents a cached result of process evaluation on a specific container name.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| containerName | String | ||||
| baselineStatus | INVALID, NOT_GENERATED, UNLOCKED, LOCKED, | ||||
| anomalousProcessesExecuted | Boolean |
21.5.7.6. StorageListDeployment
Next available tag: 9| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| hash | String | uint64 | |||
| name | String | ||||
| cluster | String | ||||
| clusterId | String | ||||
| namespace | String | ||||
| created | Date | date-time | |||
| priority | String | int64 |
21.5.7.7. V1ListDeploymentsWithProcessInfoResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| deployments | List of ListDeploymentsWithProcessInfoResponseDeploymentWithProcessInfo |
21.6. GetDeploymentWithRisk
GET /v1/deploymentswithrisk/{id}
GetDeploymentWithRisk returns a deployment and its risk given its ID.
21.6.1. Description
21.6.2. Parameters
21.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
21.6.3. Return Type
21.6.4. Content Type
- application/json
21.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.6.6. Samples
21.6.7. Common object reference
21.6.7.1. ContainerConfigEnvironmentConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| value | String | ||||
| envVarSource | UNSET, RAW, SECRET_KEY, CONFIG_MAP_KEY, FIELD, RESOURCE_FIELD, UNKNOWN, |
21.6.7.2. EnvironmentConfigEnvVarSource
For any update to EnvVarSource, please also update 'ui/src/messages/common.js'| Enum Values |
|---|
| UNSET |
| RAW |
| SECRET_KEY |
| CONFIG_MAP_KEY |
| FIELD |
| RESOURCE_FIELD |
| UNKNOWN |
21.6.7.3. PortConfigExposureInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| level | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| serviceName | String | ||||
| serviceId | String | ||||
| serviceClusterIp | String | ||||
| servicePort | Integer | int32 | |||
| nodePort | Integer | int32 | |||
| externalIps |
List of | ||||
| externalHostnames |
List of |
21.6.7.4. PortConfigExposureLevel
| Enum Values |
|---|
| UNSET |
| EXTERNAL |
| NODE |
| INTERNAL |
| HOST |
| ROUTE |
21.6.7.5. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.6.7.5.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.6.7.6. ResultFactor
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| message | String | ||||
| url | String |
21.6.7.7. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.6.7.8. SeccompProfileProfileType
| Enum Values |
|---|
| UNCONFINED |
| RUNTIME_DEFAULT |
| LOCALHOST |
21.6.7.9. SecurityContextSELinux
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| user | String | ||||
| role | String | ||||
| type | String | ||||
| level | String |
21.6.7.10. SecurityContextSeccompProfile
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| type | UNCONFINED, RUNTIME_DEFAULT, LOCALHOST, | ||||
| localhostProfile | String |
21.6.7.11. StorageContainer
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| config | |||||
| image | |||||
| securityContext | |||||
| volumes | List of StorageVolume | ||||
| ports | List of StoragePortConfig | ||||
| secrets | List of StorageEmbeddedSecret | ||||
| resources | |||||
| name | String | ||||
| livenessProbe | |||||
| readinessProbe |
21.6.7.12. StorageContainerConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| env | List of ContainerConfigEnvironmentConfig | ||||
| command |
List of | ||||
| args |
List of | ||||
| directory | String | ||||
| user | String | ||||
| uid | String | int64 | |||
| appArmorProfile | String |
21.6.7.13. StorageContainerImage
Next tag: 12| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | |||||
| notPullable | Boolean | ||||
| isClusterLocal | Boolean |
21.6.7.14. StorageDeployment
Next available tag: 35| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| hash | String | uint64 | |||
| type | String | ||||
| namespace | String | ||||
| namespaceId | String | ||||
| orchestratorComponent | Boolean | ||||
| replicas | String | int64 | |||
| labels |
Map of | ||||
| podLabels |
Map of | ||||
| labelSelector | |||||
| created | Date | date-time | |||
| clusterId | String | ||||
| clusterName | String | ||||
| containers | List of StorageContainer | ||||
| annotations |
Map of | ||||
| priority | String | int64 | |||
| inactive | Boolean | ||||
| imagePullSecrets |
List of | ||||
| serviceAccount | String | ||||
| serviceAccountPermissionLevel | UNSET, NONE, DEFAULT, ELEVATED_IN_NAMESPACE, ELEVATED_CLUSTER_WIDE, CLUSTER_ADMIN, | ||||
| automountServiceAccountToken | Boolean | ||||
| hostNetwork | Boolean | ||||
| hostPid | Boolean | ||||
| hostIpc | Boolean | ||||
| runtimeClass | String | ||||
| tolerations | List of StorageToleration | ||||
| ports | List of StoragePortConfig | ||||
| stateTimestamp | String | int64 | |||
| riskScore | Float | float |
21.6.7.15. StorageEmbeddedSecret
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| path | String |
21.6.7.16. StorageImageName
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| registry | String | ||||
| remote | String | ||||
| tag | String | ||||
| fullName | String |
21.6.7.17. StorageLabelSelector
Label selector components are joined with logical AND, see https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| matchLabels |
Map of | This is actually a oneof, but we can’t make it one due to backwards compatibility constraints. | |||
| requirements | List of StorageLabelSelectorRequirement |
21.6.7.18. StorageLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
21.6.7.19. StorageLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
21.6.7.20. StorageLivenessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.6.7.21. StoragePermissionLevel
For any update to PermissionLevel, also update: - pkg/searchbasedpolicies/builders/k8s_rbac.go - ui/src/messages/common.js| Enum Values |
|---|
| UNSET |
| NONE |
| DEFAULT |
| ELEVATED_IN_NAMESPACE |
| ELEVATED_CLUSTER_WIDE |
| CLUSTER_ADMIN |
21.6.7.22. StoragePortConfig
Next Available Tag: 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| containerPort | Integer | int32 | |||
| protocol | String | ||||
| exposure | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| exposedPort | Integer | int32 | |||
| exposureInfos | List of PortConfigExposureInfo |
21.6.7.23. StorageReadinessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.6.7.24. StorageResources
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| cpuCoresRequest | Float | float | |||
| cpuCoresLimit | Float | float | |||
| memoryMbRequest | Float | float | |||
| memoryMbLimit | Float | float |
21.6.7.25. StorageRisk
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| subject | |||||
| score | Float | float | |||
| results | List of StorageRiskResult |
21.6.7.26. StorageRiskResult
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| factors | List of ResultFactor | ||||
| score | Float | float |
21.6.7.27. StorageRiskSubject
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| namespace | String | ||||
| clusterId | String | ||||
| type | UNKNOWN, DEPLOYMENT, NAMESPACE, CLUSTER, NODE, NODE_COMPONENT, IMAGE, IMAGE_COMPONENT, SERVICEACCOUNT, |
21.6.7.28. StorageRiskSubjectType
Next tag: 9| Enum Values |
|---|
| UNKNOWN |
| DEPLOYMENT |
| NAMESPACE |
| CLUSTER |
| NODE |
| NODE_COMPONENT |
| IMAGE |
| IMAGE_COMPONENT |
| SERVICEACCOUNT |
21.6.7.29. StorageSecurityContext
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| privileged | Boolean | ||||
| selinux | |||||
| dropCapabilities |
List of | ||||
| addCapabilities |
List of | ||||
| readOnlyRootFilesystem | Boolean | ||||
| seccompProfile | |||||
| allowPrivilegeEscalation | Boolean |
21.6.7.30. StorageTaintEffect
| Enum Values |
|---|
| UNKNOWN_TAINT_EFFECT |
| NO_SCHEDULE_TAINT_EFFECT |
| PREFER_NO_SCHEDULE_TAINT_EFFECT |
| NO_EXECUTE_TAINT_EFFECT |
21.6.7.31. StorageToleration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| operator | TOLERATION_OPERATION_UNKNOWN, TOLERATION_OPERATOR_EXISTS, TOLERATION_OPERATOR_EQUAL, | ||||
| value | String | ||||
| taintEffect | UNKNOWN_TAINT_EFFECT, NO_SCHEDULE_TAINT_EFFECT, PREFER_NO_SCHEDULE_TAINT_EFFECT, NO_EXECUTE_TAINT_EFFECT, |
21.6.7.32. StorageTolerationOperator
| Enum Values |
|---|
| TOLERATION_OPERATION_UNKNOWN |
| TOLERATION_OPERATOR_EXISTS |
| TOLERATION_OPERATOR_EQUAL |
21.6.7.33. StorageVolume
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| source | String | ||||
| destination | String | ||||
| readOnly | Boolean | ||||
| type | String | ||||
| mountPropagation | NONE, HOST_TO_CONTAINER, BIDIRECTIONAL, |
21.6.7.34. V1GetDeploymentWithRiskResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| deployment | |||||
| risk |
21.6.7.35. VolumeMountPropagation
| Enum Values |
|---|
| NONE |
| HOST_TO_CONTAINER |
| BIDIRECTIONAL |
21.7. ExportDeployments
GET /v1/export/deployments
21.7.1. Description
21.7.2. Parameters
21.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
21.7.3. Return Type
21.7.4. Content Type
- application/json
21.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | |
| 0 | An unexpected error response. |
21.7.6. Samples
21.7.7. Common object reference
21.7.7.1. ContainerConfigEnvironmentConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| value | String | ||||
| envVarSource | UNSET, RAW, SECRET_KEY, CONFIG_MAP_KEY, FIELD, RESOURCE_FIELD, UNKNOWN, |
21.7.7.2. EnvironmentConfigEnvVarSource
For any update to EnvVarSource, please also update 'ui/src/messages/common.js'| Enum Values |
|---|
| UNSET |
| RAW |
| SECRET_KEY |
| CONFIG_MAP_KEY |
| FIELD |
| RESOURCE_FIELD |
| UNKNOWN |
21.7.7.3. PortConfigExposureInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| level | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| serviceName | String | ||||
| serviceId | String | ||||
| serviceClusterIp | String | ||||
| servicePort | Integer | int32 | |||
| nodePort | Integer | int32 | |||
| externalIps |
List of | ||||
| externalHostnames |
List of |
21.7.7.4. PortConfigExposureLevel
| Enum Values |
|---|
| UNSET |
| EXTERNAL |
| NODE |
| INTERNAL |
| HOST |
| ROUTE |
21.7.7.5. ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}Example 3: Pack and unpack a message in Python.foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...Example 4: Pack and unpack a message in Gofoo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
21.7.7.5.1. JSON representation
The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| typeUrl | String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in | |||
| value | byte[] | Must be a valid serialized protocol buffer of the above specified type. | byte |
21.7.7.6. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
21.7.7.7. RuntimeStreamError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| grpcCode | Integer | int32 | |||
| httpCode | Integer | int32 | |||
| message | String | ||||
| httpStatus | String | ||||
| details | List of ProtobufAny |
21.7.7.8. SeccompProfileProfileType
| Enum Values |
|---|
| UNCONFINED |
| RUNTIME_DEFAULT |
| LOCALHOST |
21.7.7.9. SecurityContextSELinux
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| user | String | ||||
| role | String | ||||
| type | String | ||||
| level | String |
21.7.7.10. SecurityContextSeccompProfile
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| type | UNCONFINED, RUNTIME_DEFAULT, LOCALHOST, | ||||
| localhostProfile | String |
21.7.7.11. StorageContainer
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| config | |||||
| image | |||||
| securityContext | |||||
| volumes | List of StorageVolume | ||||
| ports | List of StoragePortConfig | ||||
| secrets | List of StorageEmbeddedSecret | ||||
| resources | |||||
| name | String | ||||
| livenessProbe | |||||
| readinessProbe |
21.7.7.12. StorageContainerConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| env | List of ContainerConfigEnvironmentConfig | ||||
| command |
List of | ||||
| args |
List of | ||||
| directory | String | ||||
| user | String | ||||
| uid | String | int64 | |||
| appArmorProfile | String |
21.7.7.13. StorageContainerImage
Next tag: 12| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | |||||
| notPullable | Boolean | ||||
| isClusterLocal | Boolean |
21.7.7.14. StorageDeployment
Next available tag: 35| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| hash | String | uint64 | |||
| type | String | ||||
| namespace | String | ||||
| namespaceId | String | ||||
| orchestratorComponent | Boolean | ||||
| replicas | String | int64 | |||
| labels |
Map of | ||||
| podLabels |
Map of | ||||
| labelSelector | |||||
| created | Date | date-time | |||
| clusterId | String | ||||
| clusterName | String | ||||
| containers | List of StorageContainer | ||||
| annotations |
Map of | ||||
| priority | String | int64 | |||
| inactive | Boolean | ||||
| imagePullSecrets |
List of | ||||
| serviceAccount | String | ||||
| serviceAccountPermissionLevel | UNSET, NONE, DEFAULT, ELEVATED_IN_NAMESPACE, ELEVATED_CLUSTER_WIDE, CLUSTER_ADMIN, | ||||
| automountServiceAccountToken | Boolean | ||||
| hostNetwork | Boolean | ||||
| hostPid | Boolean | ||||
| hostIpc | Boolean | ||||
| runtimeClass | String | ||||
| tolerations | List of StorageToleration | ||||
| ports | List of StoragePortConfig | ||||
| stateTimestamp | String | int64 | |||
| riskScore | Float | float |
21.7.7.15. StorageEmbeddedSecret
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| path | String |
21.7.7.16. StorageImageName
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| registry | String | ||||
| remote | String | ||||
| tag | String | ||||
| fullName | String |
21.7.7.17. StorageLabelSelector
Label selector components are joined with logical AND, see https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| matchLabels |
Map of | This is actually a oneof, but we can’t make it one due to backwards compatibility constraints. | |||
| requirements | List of StorageLabelSelectorRequirement |
21.7.7.18. StorageLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
21.7.7.19. StorageLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
21.7.7.20. StorageLivenessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.7.7.21. StoragePermissionLevel
For any update to PermissionLevel, also update: - pkg/searchbasedpolicies/builders/k8s_rbac.go - ui/src/messages/common.js| Enum Values |
|---|
| UNSET |
| NONE |
| DEFAULT |
| ELEVATED_IN_NAMESPACE |
| ELEVATED_CLUSTER_WIDE |
| CLUSTER_ADMIN |
21.7.7.22. StoragePortConfig
Next Available Tag: 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| containerPort | Integer | int32 | |||
| protocol | String | ||||
| exposure | UNSET, EXTERNAL, NODE, INTERNAL, HOST, ROUTE, | ||||
| exposedPort | Integer | int32 | |||
| exposureInfos | List of PortConfigExposureInfo |
21.7.7.23. StorageReadinessProbe
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| defined | Boolean |
21.7.7.24. StorageResources
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| cpuCoresRequest | Float | float | |||
| cpuCoresLimit | Float | float | |||
| memoryMbRequest | Float | float | |||
| memoryMbLimit | Float | float |
21.7.7.25. StorageSecurityContext
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| privileged | Boolean | ||||
| selinux | |||||
| dropCapabilities |
List of | ||||
| addCapabilities |
List of | ||||
| readOnlyRootFilesystem | Boolean | ||||
| seccompProfile | |||||
| allowPrivilegeEscalation | Boolean |
21.7.7.26. StorageTaintEffect
| Enum Values |
|---|
| UNKNOWN_TAINT_EFFECT |
| NO_SCHEDULE_TAINT_EFFECT |
| PREFER_NO_SCHEDULE_TAINT_EFFECT |
| NO_EXECUTE_TAINT_EFFECT |
21.7.7.27. StorageToleration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| operator | TOLERATION_OPERATION_UNKNOWN, TOLERATION_OPERATOR_EXISTS, TOLERATION_OPERATOR_EQUAL, | ||||
| value | String | ||||
| taintEffect | UNKNOWN_TAINT_EFFECT, NO_SCHEDULE_TAINT_EFFECT, PREFER_NO_SCHEDULE_TAINT_EFFECT, NO_EXECUTE_TAINT_EFFECT, |
21.7.7.28. StorageTolerationOperator
| Enum Values |
|---|
| TOLERATION_OPERATION_UNKNOWN |
| TOLERATION_OPERATOR_EXISTS |
| TOLERATION_OPERATOR_EQUAL |
21.7.7.29. StorageVolume
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| name | String | ||||
| source | String | ||||
| destination | String | ||||
| readOnly | Boolean | ||||
| type | String | ||||
| mountPropagation | NONE, HOST_TO_CONTAINER, BIDIRECTIONAL, |
21.7.7.30. StreamResultOfV1ExportDeploymentResponse
Stream result of v1ExportDeploymentResponse| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| result | |||||
| error |
21.7.7.31. V1ExportDeploymentResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| deployment |
21.7.7.32. VolumeMountPropagation
| Enum Values |
|---|
| NONE |
| HOST_TO_CONTAINER |
| BIDIRECTIONAL |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}