DynamicEnv CRD Reference

Packages

• riskified.com/v1alpha1

riskified.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the riskified v1alpha1 API group

Resource Types

• DynamicEnv

ConsumerStatus

Appears in:

• DynamicEnvStatus

Field	Description
name string	The name of the resource
namespace string	The namespace where the resource is created
status LifeCycleStatus	The life cycle status of the resource
hash integer	Hash of the current consumer - for internal use
errors StatusError array	List of errors related to the consumer

ContainerOverrides

Defines the details of the container on which changes need to be made and the relevant overrides

Appears in:

• Subset

Field	Description
containerName string	Container name to override in multiple containers' environment. If not specified, we will use the first container.
image string	Docker image name overridden to the desired subset The Docker image found in the original deployment is used if this is not provided.
command string array	Entrypoint array overridden to the desired subset The docker image's ENTRYPOINT is used if this is not provided.
env EnvVar array	Additional environment variable to the given deployment

DynamicEnv

DynamicEnv is the Schema for the dynamicenvs API

Field	Description
apiVersion string	riskified.com/v1alpha1
kind string	DynamicEnv
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec DynamicEnvSpec
status DynamicEnvStatus

DynamicEnvSpec

DynamicEnvSpec defines the desired state of DynamicEnv

Appears in:

• DynamicEnv

Field	Description
istioMatches IstioMatch array	A list of matchers (partly corresponds to IstioMatch). Each match will have a rule of its own (merged with existing rules) ordered by their order here.
subsets Subset array	Who should participate in the given dynamic environment
consumers Subset array	Consumers are like subsets but for deployments that do not open a service but connect to external resources for their work (e.g., offline workers). They are equivalent to subsets in the sense that they launch overriding deployments with custom image and/or settings. However, since they are only consumers, no virtual service or destination route will be pointing to them.

DynamicEnvStatus

DynamicEnvStatus defines the observed state of DynamicEnv

Appears in:

• DynamicEnv

Field	Description
subsetsStatus object (keys:string, values:SubsetStatus)	A detailed status of each subset
consumersStatus object (keys:string, values:ConsumerStatus)	A detailed status of each consumer
state GlobalReadyStatus
totalCount integer	desired subsets and consumers count
totalReady integer	number of available subsets and consumers

IstioMatch

specifies a set of criterion to be met in order for the rule to be applied to the HTTP request This field is immutable after creation.

Appears in:

• DynamicEnvSpec

Field	Description
headers object (keys:string, values:StringMatch)	Header values are case-sensitive and formatted as follows: - exact: "value" for exact string match - prefix: "value" for prefix-based match - regex: "value" for RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax).
sourceLabels object (keys:string, values:string)	One or more labels that constrain the applicability of a rule to source (client) workloads with the given labels.

ResourceStatus

ResourceStatus shows the status of each item created/edited by DynamicEnv

Appears in:

• ConsumerStatus
• SubsetStatus

Field	Description
name string	The name of the resource
namespace string	The namespace where the resource is created
status LifeCycleStatus	The life cycle status of the resource

StatusError

StatusError shows an error we want to display in the status with the last time it happened. This does not have to be the only time it happened. The idea is that a list of errors should only contain a single occurrence of an error (just the last).

Appears in:

• ConsumerStatus
• SubsetErrors

StringMatch

Describes how to match a given string in HTTP headers. Match is case-sensitive. one and only one of the fields needs to be defined (oneof)

Appears in:

• IstioMatch

Field	Description
exact string
prefix string
regex string

Subset

Subsets define how to generate subsets from existing Deployments

Appears in:

• DynamicEnvSpec

Field	Description
name string	Deployment name (without namespace)
namespace string	Namespace where the deployment is deployed
podLabels object (keys:string, values:string)	Labels to add to the pods of the deployment launched by this subset. Could be used in conjunction with 'SourceLabels' in the IstioMatches.
replicas integer	Number of deployment replicas. Default is 1. Note: 0 is invalid.
containers ContainerOverrides array	A list of container overrides (at least one of Containers or InitContainers must not be empty)
initContainers ContainerOverrides array	A list of init container overrides (at least one of Containers or InitContainers must not be empty)
defaultVersion string	Default version for this subset (if different then the global default version). This is the version that will get the default route.

SubsetErrors

SubsetErrors contains all global errors related to set subset.

Appears in:

• SubsetStatus

Field	Description
deployment StatusError array	Subset's deployment global errors.
destinationRule StatusError array	Subset's destination-rule global errors.
virtualServices StatusError array	Subset's virtual-services global errors.
subset StatusError array	Errors related to subset but not to any of the launched resources

SubsetStatus

SubsetStatus Contains aggregation of all resource status connected to set subset.

Appears in:

• DynamicEnvStatus

Field	Description
deployment ResourceStatus	Status of the deployment that belongs to the subset
destinationRules ResourceStatus array	Status of the destination-rule that belongs to the subset
virtualServices ResourceStatus array	Status of the virtual-service that belongs to the subset
subsetErrors SubsetErrors	A list of global errors related to subset resources
hash integer	Hash of the current subset - for internal use