Struct MaterializeSpec

pub struct MaterializeSpec {

    pub environmentd_image_ref: String,
    pub environmentd_extra_args: Option<Vec<String>>,
    pub environmentd_extra_env: Option<Vec<EnvVar>>,
    pub environmentd_iam_role_arn: Option<String>,
    pub environmentd_connection_role_arn: Option<String>,
    pub environmentd_resource_requirements: Option<ResourceRequirements>,
    pub environmentd_scratch_volume_storage_requirement: Option<Quantity>,
    pub balancerd_resource_requirements: Option<ResourceRequirements>,
    pub console_resource_requirements: Option<ResourceRequirements>,
    pub balancerd_replicas: Option<i32>,
    pub console_replicas: Option<i32>,
    pub service_account_name: Option<String>,
    pub service_account_annotations: Option<BTreeMap<String, String>>,
    pub service_account_labels: Option<BTreeMap<String, String>>,
    pub pod_annotations: Option<BTreeMap<String, String>>,
    pub pod_labels: Option<BTreeMap<String, String>>,
    pub request_rollout: Uuid,
    pub force_promote: Uuid,
    pub force_rollout: Uuid,
    pub in_place_rollout: bool,
    pub rollout_strategy: MaterializeRolloutStrategy,
    pub backend_secret_name: String,
    pub authenticator_kind: AuthenticatorKind,
    pub enable_rbac: bool,
    pub environment_id: Uuid,
    pub balancerd_external_certificate_spec: Option<MaterializeCertSpec>,
    pub console_external_certificate_spec: Option<MaterializeCertSpec>,
    pub internal_certificate_spec: Option<MaterializeCertSpec>,
}

Fields

environmentd_image_ref: String

The environmentd image to run.

environmentd_extra_args: Option<Vec<String>>

Extra args to pass to the environmentd binary.

environmentd_extra_env: Option<Vec<EnvVar>>

Extra environment variables to pass to the environmentd binary.

environmentd_iam_role_arn: Option<String>

{{}} Deprecated.

Use service_account_annotations to set “eks.amazonaws.com/role-arn” instead. {{}}

If running in AWS, override the IAM role to use to give environmentd access to the persist S3 bucket.

environmentd_connection_role_arn: Option<String>

If running in AWS, override the IAM role to use to support the CREATE CONNECTION feature.

environmentd_resource_requirements: Option<ResourceRequirements>

Resource requirements for the environmentd pod.

environmentd_scratch_volume_storage_requirement: Option<Quantity>

Amount of disk to allocate, if a storage class is provided.

balancerd_resource_requirements: Option<ResourceRequirements>

Resource requirements for the balancerd pod.

console_resource_requirements: Option<ResourceRequirements>

Resource requirements for the console pod.

balancerd_replicas: Option<i32>

Number of balancerd pods to create.

console_replicas: Option<i32>

Number of console pods to create.

service_account_name: Option<String>

Name of the kubernetes service account to use. If not set, we will create one with the same name as this Materialize object.

service_account_annotations: Option<BTreeMap<String, String>>

Annotations to apply to the service account.

Annotations on service accounts are commonly used by cloud providers for IAM. AWS uses “eks.amazonaws.com/role-arn”. Azure uses “azure.workload.identity/client-id”, but additionally requires “azure.workload.identity/use”: “true” on the pods.

service_account_labels: Option<BTreeMap<String, String>>

Labels to apply to the service account.

pod_annotations: Option<BTreeMap<String, String>>

Annotations to apply to the pods.

pod_labels: Option<BTreeMap<String, String>>

Labels to apply to the pods.

request_rollout: Uuid

When changes are made to the environmentd resources (either via modifying fields in the spec here or by deploying a new orchestratord version which changes how resources are generated), existing environmentd processes won’t be automatically restarted. In order to trigger a restart, the request_rollout field should be set to a new (random) value. Once the rollout completes, the value of status.lastCompletedRolloutRequest will be set to this value to indicate completion.

Defaults to a random value in order to ensure that the first generation rollout is automatically triggered.

force_promote: Uuid

If forcePromote is set to the same value as requestRollout, the current rollout will skip waiting for clusters in the new generation to rehydrate before promoting the new environmentd to leader.

force_rollout: Uuid

This value will be written to an annotation in the generated environmentd statefulset, in order to force the controller to detect the generated resources as changed even if no other changes happened. This can be used to force a rollout to a new generation even without making any meaningful changes, by setting it to the same value as requestRollout.

in_place_rollout: bool

{{}} Deprecated and ignored. Use rolloutStrategy instead. {{}}

rollout_strategy: MaterializeRolloutStrategy

Rollout strategy to use when upgrading this Materialize instance.

backend_secret_name: String

The name of a secret containing metadata_backend_url and persist_backend_url. It may also contain external_login_password_mz_system, which will be used as the password for the mz_system user if authenticatorKind is Password.

authenticator_kind: AuthenticatorKind

How to authenticate with Materialize.

enable_rbac: bool

Whether to enable role based access control. Defaults to false.

environment_id: Uuid

The value used by environmentd (via the –environment-id flag) to uniquely identify this instance. Must be globally unique, and is required if a license key is not provided. NOTE: This value MUST NOT be changed in an existing instance, since it affects things like the way data is stored in the persist backend.

balancerd_external_certificate_spec: Option<MaterializeCertSpec>

The configuration for generating an x509 certificate using cert-manager for balancerd to present to incoming connections. The dnsNames and issuerRef fields are required.

console_external_certificate_spec: Option<MaterializeCertSpec>

The configuration for generating an x509 certificate using cert-manager for the console to present to incoming connections. The dnsNames and issuerRef fields are required. Not yet implemented.

internal_certificate_spec: Option<MaterializeCertSpec>

The cert-manager Issuer or ClusterIssuer to use for database internal communication. The issuerRef field is required. This currently is only used for environmentd, but will eventually support clusterd.

Trait Implementations

impl Clone for MaterializeSpec

fn clone(&self) -> MaterializeSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MaterializeSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MaterializeSpec

fn default() -> MaterializeSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MaterializeSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MaterializeSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for MaterializeSpec

fn eq(&self, other: &MaterializeSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MaterializeSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MaterializeSpec