TFOperator custom resource

The resource of kind TFOperator is a custom resource defined by a resource of kind CustomResourceDefinition.

The CustomResourceDefinition resource in Kubernetes uses the OpenAPI Specification version 2 to specify the schema of the defined resource. The Kubernetes API outright rejects the resources that do not pass this schema validation. Along with schema validation, TFOperator uses ValidatingAdmissionWebhook for extended validations when a custom resource is created or updated.

Important

Since 24.1, MOSK introduces the technical preview support for the API v2 for the Tungsten Fabric Operator. This version of the Tungsten Fabric Operator API aligns with the OpenStack Controller API and provides better interface for advanced configurations. Refer to Key differences between TFOperator API v1alpha1 and v2 for details.

For the list of configuration options available to a cloud operator, refer to Tungsten Fabric configuration. Also, check out the Tungsten Fabric API Reference document of the MOSK version that your cluster has been deployed with.

TFOperator custom resource validation

Tungsten Fabric Operator uses ValidatingAdmissionWebhook to validate environment variables set to Tungsten Fabric components upon the TFOperator object creation or update. The following validations are performed:

• Environment variables passed to the Tungsten Fabric components containers

• Mapping between tfVersion and tfImageTag, if defined

• Schedule for dbBackup

• Data capacity format

• Feature variable values

• Availability of the dataStorageClass class

If required, you can disable ValidatingAdmissionWebhook through the TFOperator HelmBundle resource:

apiVersion: lcm.mirantis.com/v1alpha1
kind: HelmBundle
metadata:
  name: tungstenfabric-operator
  namespace: tf
spec:
  releases:
  - name: tungstenfabric-operator
    values:
      admission:
        enabled: false

Environment variables for Tungsten Fabric components

API v2 Available since MOSK 24.1

Warning

The features section of the TFOperator specification allows for easy configuration of all Tungsten Fabric features. Mirantis recommends updating the environment variables through envSettings directly.

Allowed environment variables for Tungsten Fabric components

Environment variables	Tungsten Fabric service and envSettings name
INTROSPECT_LISTEN_ALL	analytics (alarmGen, api, collector, nodeMgr, query, snmp, topology) config (api, db-nodemgr, nodeMgr) control (control, dns, nodeMgr) vRouter (agent, nodeMgr)
PROVISION_DELAY PROVISION_RETRIES BGP_ASN ENCAP_PRIORITY VXLAN_VN_ID_MODE	analytics (provisioner) config (provisioner) control (provisioner) agent (provisioner) agentDPDK (provisioner)
CONFIG_API_LIST_OPTIMIZATION_ENABLED CONFIG_API_WORKER_COUNT CONFIG_API_MAX_REQUESTS FWAAS_ENABLE RABBITMQ_HEARTBEAT_INTERVAL DISABLE_VNC_API_STATS	config (api)
DNS_NAMED_MAX_CACHE_SIZE DNS_NAMED_MAX_RETRANSMISSIONS DNS_RETRANSMISSION_INTERVAL	control (dns)
WEBUI_LOG_LEVEL WEBUI_STATIC_AUTH_PASSWORD WEBUI_STATIC_AUTH_ROLE WEBUI_STATIC_AUTH_USER	webui (job, web)
ANALYTICS_CONFIG_AUDIT_TTL ANALYTICS_DATA_TTL ANALYTICS_FLOW_TTL ANALYTICS_STATISTICS_TTL COLLECTOR_disk_usage_percentage_high_watermark0 COLLECTOR_disk_usage_percentage_high_watermark1 COLLECTOR_disk_usage_percentage_high_watermark2 COLLECTOR_disk_usage_percentage_low_watermark0 COLLECTOR_disk_usage_percentage_low_watermark1 COLLECTOR_disk_usage_percentage_low_watermark2 COLLECTOR_high_watermark0_message_severity_level COLLECTOR_high_watermark1_message_severity_level COLLECTOR_high_watermark2_message_severity_level COLLECTOR_low_watermark0_message_severity_level COLLECTOR_low_watermark1_message_severity_level COLLECTOR_low_watermark2_message_severity_level COLLECTOR_pending_compaction_tasks_high_watermark0 COLLECTOR_pending_compaction_tasks_high_watermark1 COLLECTOR_pending_compaction_tasks_high_watermark2 COLLECTOR_pending_compaction_tasks_low_watermark0 COLLECTOR_pending_compaction_tasks_low_watermark1 COLLECTOR_pending_compaction_tasks_low_watermark2 COLLECTOR_LOG_FILE_COUNT COLLECTOR_LOG_FILE_SIZE	analytics (collector)
ANALYTICS_DATA_TTL QUERYENGINE_MAX_SLICE QUERYENGINE_MAX_TASKS QUERYENGINE_START_TIME	analytics (query)
SNMPCOLLECTOR_FAST_SCAN_FREQUENCY SNMPCOLLECTOR_SCAN_FREQUENCY	analytics (snmp)
TOPOLOGY_SCAN_FREQUENCY	analytics (topology)
DPDK_UIO_DRIVER PHYSICAL_INTERFACE SRIOV_PHYSICAL_INTERFACE SRIOV_PHYSICAL_NETWORK SRIOV_VF TSN_AGENT_MODE TSN_NODES AGENT_MODE FABRIC_SNAT_HASH_TABLE_SIZE PRIORITY_BANDWIDTH PRIORITY_ID PRIORITY_SCHEDULING PRIORITY_TAGGING QOS_DEF_HW_QUEUE QOS_LOGICAL_QUEUES QOS_QUEUE_ID VROUTER_GATEWAY HUGE_PAGES_2MB HUGE_PAGES_1GB DISABLE_TX_OFFLOAD DISABLE_STATS_COLLECTION	vRouter (agent)
CPU_CORE_MASK SERVICE_CORE_MASK DPDK_CTRL_THREAD_MASK DPDK_COMMAND_ADDITIONAL_ARGS DPDK_MEM_PER_SOCKET DPDK_UIO_DRIVER HUGE_PAGES HUGE_PAGES_DIR NIC_OFFLOAD_ENABLE DPDK_ENABLE_VLAN_FWRD	vRouter (agentDPDK)

API v1alpha1 Deprecated since MOSK 24.2

Allowed environment variables for Tungsten Fabric components

Environment variables	Tungsten Fabric components and containers
INTROSPECT_LISTEN_ALL LOG_DIR LOG_LEVEL LOG_LOCAL	tf-analytics (alarm-gen, api, collector, alarm-nodemgr, db-nodemgr, nodemgr, snmp-nodemgr, query-engine, snmp, topology) tf-config (api, db-nodemgr, nodemgr) tf-control (control, dns, nodemgr) tf-vrouter (agent, dpdk-nodemgr, nodemgr)
LOG_DIR LOG_LEVEL LOG_LOCAL	tf-config (config, devicemgr, schema, svc-monitor)
PROVISION_DELAY PROVISION_RETRIES BGP_ASN ENCAP_PRIORITY VXLAN_VN_ID_MODE	tf-analytics (alarm-provisioner, db-provisioner, provisioner, snmp-provisioner) tf-config (db-provisioner, provisioner) tf-control (provisioner) tf-vrouter (dpdk-provisioner, provisioner)
CONFIG_API_LIST_OPTIMIZATION_ENABLED CONFIG_API_WORKER_COUNT CONFIG_API_MAX_REQUESTS FWAAS_ENABLE RABBITMQ_HEARTBEAT_INTERVAL DISABLE_VNC_API_STATS	tf-config (config)
DNS_NAMED_MAX_CACHE_SIZE DNS_NAMED_MAX_RETRANSMISSIONS DNS_RETRANSMISSION_INTERVAL	tf-control (dns)
WEBUI_LOG_LEVEL WEBUI_STATIC_AUTH_PASSWORD WEBUI_STATIC_AUTH_ROLE WEBUI_STATIC_AUTH_USER	tf-webui (job, web)
ANALYTICS_CONFIG_AUDIT_TTL ANALYTICS_DATA_TTL ANALYTICS_FLOW_TTL ANALYTICS_STATISTICS_TTL COLLECTOR_disk_usage_percentage_high_watermark0 COLLECTOR_disk_usage_percentage_high_watermark1 COLLECTOR_disk_usage_percentage_high_watermark2 COLLECTOR_disk_usage_percentage_low_watermark0 COLLECTOR_disk_usage_percentage_low_watermark1 COLLECTOR_disk_usage_percentage_low_watermark2 COLLECTOR_high_watermark0_message_severity_level COLLECTOR_high_watermark1_message_severity_level COLLECTOR_high_watermark2_message_severity_level COLLECTOR_low_watermark0_message_severity_level COLLECTOR_low_watermark1_message_severity_level COLLECTOR_low_watermark2_message_severity_level COLLECTOR_pending_compaction_tasks_high_watermark0 COLLECTOR_pending_compaction_tasks_high_watermark1 COLLECTOR_pending_compaction_tasks_high_watermark2 COLLECTOR_pending_compaction_tasks_low_watermark0 COLLECTOR_pending_compaction_tasks_low_watermark1 COLLECTOR_pending_compaction_tasks_low_watermark2 COLLECTOR_LOG_FILE_COUNT COLLECTOR_LOG_FILE_SIZE	tf-analytics (collector)
ANALYTICS_DATA_TTL QUERYENGINE_MAX_SLICE QUERYENGINE_MAX_TASKS QUERYENGINE_START_TIME	tf-analytics (query-engine)
SNMPCOLLECTOR_FAST_SCAN_FREQUENCY SNMPCOLLECTOR_SCAN_FREQUENCY	tf-analytics (snmp)
TOPOLOGY_SCAN_FREQUENCY	tf-analytics (topology)
DPDK_UIO_DRIVER PHYSICAL_INTERFACE SRIOV_PHYSICAL_INTERFACE SRIOV_PHYSICAL_NETWORK SRIOV_VF TSN_AGENT_MODE TSN_NODES AGENT_MODE FABRIC_SNAT_HASH_TABLE_SIZE PRIORITY_BANDWIDTH PRIORITY_ID PRIORITY_SCHEDULING PRIORITY_TAGGING QOS_DEF_HW_QUEUE QOS_LOGICAL_QUEUES QOS_QUEUE_ID VROUTER_GATEWAY HUGE_PAGES_2MB HUGE_PAGES_1GB DISABLE_TX_OFFLOAD DISABLE_STATS_COLLECTION	tf-vrouter (agent)
CPU_CORE_MASK SERVICE_CORE_MASK DPDK_CTRL_THREAD_MASK DPDK_COMMAND_ADDITIONAL_ARGS DPDK_MEM_PER_SOCKET DPDK_UIO_DRIVER HUGE_PAGES HUGE_PAGES_DIR NIC_OFFLOAD_ENABLE DPDK_ENABLE_VLAN_FWRD	tf-vrouter (agent-dpdk)