@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0267.public.ves.io.schema.views.workload.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.workload","description":"Workload is used to configure and deploy a workload in Virtual Kubernetes. A workload can be\neither a service or stateful service or a batch job. Services and jobs can be deployed on\nregional edges or customer sites. Services can be exposed in-cluster or by L7 or L4\nload balancer on Internet or on sites using an advertise policy.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/workloads":{"post":{"summary":"Create Workload","description":"Shape of Workload","operationId":"ves.io.schema.views.workload.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-api-create"},"x-ves-proto-rpc":"ves.io.schema.views.workload.API.Create"},"x-displayname":"Workload","x-ves-proto-service":"ves.io.schema.views.workload.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/workloads/{metadata.name}":{"put":{"summary":"Replace Workload","description":"Shape of Workload","operationId":"ves.io.schema.views.workload.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-api-replace"},"x-ves-proto-rpc":"ves.io.schema.views.workload.API.Replace"},"x-displayname":"Workload","x-ves-proto-service":"ves.io.schema.views.workload.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/workloads":{"get":{"summary":"List Workload","description":"List the set of workload in a namespace","operationId":"ves.io.schema.views.workload.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of workload","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-api-list"},"x-ves-proto-rpc":"ves.io.schema.views.workload.API.List"},"x-displayname":"Workload","x-ves-proto-service":"ves.io.schema.views.workload.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data/namespaces/{namespace}/workloads/usage":{"post":{"summary":"Usage Metrics","description":"Get the workload usage","operationId":"ves.io.schema.views.workload.CustomDataAPI.Usage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadUsageResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"ns1\"\nnamespace is used to scope the workload usage to a given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadUsageRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-customdataapi-usage"},"x-ves-proto-rpc":"ves.io.schema.views.workload.CustomDataAPI.Usage"},"x-displayname":"Workload","x-ves-proto-service":"ves.io.schema.views.workload.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/workloads/{name}":{"get":{"summary":"Get Workload","description":"Shape of Workload","operationId":"ves.io.schema.views.workload.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-api-get"},"x-ves-proto-rpc":"ves.io.schema.views.workload.API.Get"},"delete":{"summary":"Delete Workload","description":"Delete the specified workload","operationId":"ves.io.schema.views.workload.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workloadDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-workload-api-delete"},"x-ves-proto-rpc":"ves.io.schema.views.workload.API.Delete"},"x-displayname":"Workload","x-ves-proto-service":"ves.io.schema.views.workload.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Workload","x-ves-proto-package":"ves.io.schema.views.workload","components":{"schemas":{"http_loadbalancerProxyTypeHttp":{"type":"object","description":"Choice for selecting HTTP proxy","title":"HTTP Choice","x-displayname":"HTTP Choice","x-ves-displayorder":"1,3","x-ves-oneof-field-port_choice":"[\"port\",\"port_ranges\"]","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.ProxyTypeHttp","properties":{"dns_volterra_managed":{"type":"boolean","description":" DNS records for domains will be managed automatically by F5 Distributed Cloud.\n As a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature\n or a DNS CNAME record should be created in your DNS provider's portal.","title":"Manage DNS Domain","format":"boolean","x-displayname":"Automatically Manage DNS Records"},"port":{"type":"integer","description":"Exclusive with [port_ranges]\n HTTP port to Listen.\n\nExample: ` \"80\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"HTTP port to listen","format":"int64","x-displayname":"HTTP Listen Port","x-ves-example":"80","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"65535"}},"port_ranges":{"type":"string","description":"Exclusive with [port]\n A string containing a comma separated list of port ranges.\n Each port range consists of a single port or two ports separated by \"-\".\n\nExample: ` \"80,443,8080-8191,9080\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.max_ports: 64\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.unique_port_range_list: true\n","title":"Port_ranges","minLength":1,"maxLength":512,"x-displayname":"Port Ranges","x-ves-example":"80,443,8080-8191,9080","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.max_ports":"64","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.unique_port_range_list":"true"}}}},"http_loadbalancerProxyTypeHttps":{"type":"object","description":"Choice for selecting HTTP proxy with bring your own certificates","title":"BYOC HTTPS Choice","x-displayname":"BYOC HTTPS Choice","x-ves-displayorder":"1,2,24,3,4,9,16,19,20","x-ves-oneof-field-default_lb_choice":"[\"default_loadbalancer\",\"non_default_loadbalancer\"]","x-ves-oneof-field-path_normalize_choice":"[\"disable_path_normalize\",\"enable_path_normalize\"]","x-ves-oneof-field-port_choice":"[\"port\",\"port_ranges\"]","x-ves-oneof-field-server_header_choice":"[\"append_server_name\",\"default_header\",\"pass_through\",\"server_name\"]","x-ves-oneof-field-tls_certificates_choice":"[\"tls_cert_params\",\"tls_parameters\"]","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.ProxyTypeHttps","properties":{"add_hsts":{"type":"boolean","description":" Add HTTP Strict-Transport-Security response header","title":"Add HSTS","format":"boolean","x-displayname":"Add HSTS Header"},"append_server_name":{"type":"string","description":"Exclusive with [default_header pass_through server_name]\n Define the header value for the header name “server”.\n If header value is already present, it is not overwritten and passed as-is.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8096\n","title":"append_server_name","maxLength":8096,"x-displayname":"Append header value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8096"}},"coalescing_options":{"$ref":"#/components/schemas/schemaTLSCoalescingOptions"},"connection_idle_timeout":{"type":"integer","description":" The idle timeout for downstream connections. The idle timeout is defined as the\n period in which there are no active requests. When the idle timeout is reached the connection\n will be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\n This is specified in milliseconds. The default value is 2 minutes.\n\nExample: ` \"60000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 600000\n","title":"Connection Idle Timeout","format":"int64","x-displayname":"Connection Idle Timeout","x-ves-example":"60000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"600000"}},"default_header":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_loadbalancer":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_path_normalize":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_path_normalize":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_protocol_options":{"$ref":"#/components/schemas/virtual_hostHttpProtocolOptions"},"http_redirect":{"type":"boolean","description":" Redirect HTTP traffic to HTTPS","title":"HTTP Redirect","format":"boolean","x-displayname":"HTTP Redirect to HTTPS"},"non_default_loadbalancer":{"$ref":"#/components/schemas/ioschemaEmpty"},"pass_through":{"$ref":"#/components/schemas/ioschemaEmpty"},"port":{"type":"integer","description":"Exclusive with [port_ranges]\n HTTPS port to Listen.\n\nExample: ` \"443\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"HTTPS port to listen","format":"int64","x-displayname":"HTTPS Port","x-ves-example":"443","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"65535"}},"port_ranges":{"type":"string","description":"Exclusive with [port]\n A string containing a comma separated list of port ranges.\n Each port range consists of a single port or two ports separated by \"-\".\n\nExample: ` \"80,443,8080-8191,9080\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.max_ports: 64\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.unique_port_range_list: true\n","title":"Port_ranges","minLength":1,"maxLength":512,"x-displayname":"Port Ranges","x-ves-example":"80,443,8080-8191,9080","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.max_ports":"64","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.unique_port_range_list":"true"}},"server_name":{"type":"string","description":"Exclusive with [append_server_name default_header pass_through]\n Define the header value for the header name “server”.\n This will overwrite existing values, if any, for the server header.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8096\n","title":"server_name","maxLength":8096,"x-displayname":"Modify header value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8096"}},"tls_cert_params":{"$ref":"#/components/schemas/viewsDownstreamTLSCertsParams"},"tls_parameters":{"$ref":"#/components/schemas/schemaviewsDownstreamTlsParamsType"}}},"http_loadbalancerProxyTypeHttpsAutoCerts":{"type":"object","description":"Choice for selecting HTTP proxy with bring your own certificates","title":"HTTPS with Auto Certs Choice","x-displayname":"HTTPS with Auto Certs Choice","x-ves-displayorder":"1,2,25,3,4,7,12,19,22,23","x-ves-oneof-field-default_lb_choice":"[\"default_loadbalancer\",\"non_default_loadbalancer\"]","x-ves-oneof-field-mtls_choice":"[\"no_mtls\",\"use_mtls\"]","x-ves-oneof-field-path_normalize_choice":"[\"disable_path_normalize\",\"enable_path_normalize\"]","x-ves-oneof-field-port_choice":"[\"port\",\"port_ranges\"]","x-ves-oneof-field-server_header_choice":"[\"append_server_name\",\"default_header\",\"pass_through\",\"server_name\"]","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.ProxyTypeHttpsAutoCerts","properties":{"add_hsts":{"type":"boolean","description":" Add HTTP Strict-Transport-Security response header","title":"Add HSTS","format":"boolean","x-displayname":"Add HSTS Header"},"append_server_name":{"type":"string","description":"Exclusive with [default_header pass_through server_name]\n Define the header value for the header name “server”.\n If header value is already present, it is not overwritten and passed as-is.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8096\n","title":"append_server_name","maxLength":8096,"x-displayname":"Append header value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8096"}},"coalescing_options":{"$ref":"#/components/schemas/schemaTLSCoalescingOptions"},"connection_idle_timeout":{"type":"integer","description":" The idle timeout for downstream connections. The idle timeout is defined as the\n period in which there are no active requests. When the idle timeout is reached the connection\n will be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\n This is specified in milliseconds. The default value is 2 minutes.\n\nExample: ` \"60000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 600000\n","title":"Connection Idle Timeout","format":"int64","x-displayname":"Connection Idle Timeout","x-ves-example":"60000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"600000"}},"default_header":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_loadbalancer":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_path_normalize":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_path_normalize":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_protocol_options":{"$ref":"#/components/schemas/virtual_hostHttpProtocolOptions"},"http_redirect":{"type":"boolean","description":" Redirect HTTP traffic to HTTPS","title":"HTTP Redirect","format":"boolean","x-displayname":"HTTP Redirect to HTTPS"},"no_mtls":{"$ref":"#/components/schemas/ioschemaEmpty"},"non_default_loadbalancer":{"$ref":"#/components/schemas/ioschemaEmpty"},"pass_through":{"$ref":"#/components/schemas/ioschemaEmpty"},"port":{"type":"integer","description":"Exclusive with [port_ranges]\n HTTPS port to Listen.\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"HTTPS port to listen","format":"int64","x-displayname":"HTTPS Listen Port","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"65535"}},"port_ranges":{"type":"string","description":"Exclusive with [port]\n A string containing a comma separated list of port ranges.\n Each port range consists of a single port or two ports separated by \"-\".\n\nExample: ` \"80,443,8080-8191,9080\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.max_ports: 64\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.unique_port_range_list: true\n","title":"Port_ranges","minLength":1,"maxLength":512,"x-displayname":"Port Ranges","x-ves-example":"80,443,8080-8191,9080","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.max_ports":"64","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.unique_port_range_list":"true"}},"server_name":{"type":"string","description":"Exclusive with [append_server_name default_header pass_through]\n Define the header value for the header name “server”.\n This will overwrite existing values, if any, for the server header.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8096\n","title":"server_name","maxLength":8096,"x-displayname":"Modify header value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8096"}},"tls_config":{"$ref":"#/components/schemas/viewsTlsConfig"},"use_mtls":{"$ref":"#/components/schemas/viewsDownstreamTlsValidationContext"}}},"http_loadbalancerRouteTypeCustomRoute":{"type":"object","description":"A custom route uses a route object created outside of this view.","title":"RouteTypeCustomRoute","x-displayname":"Custom Route Object","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.RouteTypeCustomRoute","properties":{"route_ref":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"http_loadbalancerRouteTypeDirectResponse":{"type":"object","description":"A direct response route matches on path, incoming header, incoming port and/or HTTP method\nand responds directly to the matching traffic","title":"RouteTypeDirectResponse","x-displayname":"Direct Response Route","x-ves-displayorder":"2,1,4,5,3","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.RouteTypeDirectResponse","properties":{"headers":{"type":"array","description":" List of (key, value) headers\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"headers","maxItems":16,"items":{"$ref":"#/components/schemas/ioschemaHeaderMatcherType"},"x-displayname":"Headers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"http_method":{"$ref":"#/components/schemas/schemaHttpMethod"},"incoming_port":{"$ref":"#/components/schemas/ioschemaPortMatcherType"},"path":{"$ref":"#/components/schemas/ioschemaPathMatcherType"},"route_direct_response":{"$ref":"#/components/schemas/routeRouteDirectResponse"}}},"http_loadbalancerRouteTypeRedirect":{"type":"object","description":"A redirect route matches on path, incoming header, incoming port and/or HTTP method\nand redirects the matching traffic to a different URL","title":"RouteTypeRedirect","x-displayname":"Redirect Route","x-ves-displayorder":"2,1,4,5,3","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.RouteTypeRedirect","properties":{"headers":{"type":"array","description":" List of (key, value) headers\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"headers","maxItems":16,"items":{"$ref":"#/components/schemas/ioschemaHeaderMatcherType"},"x-displayname":"Headers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"http_method":{"$ref":"#/components/schemas/schemaHttpMethod"},"incoming_port":{"$ref":"#/components/schemas/ioschemaPortMatcherType"},"path":{"$ref":"#/components/schemas/ioschemaPathMatcherType"},"route_redirect":{"$ref":"#/components/schemas/routeRouteRedirect"}}},"http_loadbalancerRouteTypeSimpleWithDefaultOriginPool":{"type":"object","description":"A simple route matches on path and/or HTTP method and forwards the matching traffic to the default origin pool specified outside","title":"RouteTypeSimpleWithDefaultOriginPool","x-displayname":"Simple Route","x-ves-displayorder":"1,2,3","x-ves-oneof-field-host_rewrite_params":"[\"auto_host_rewrite\",\"disable_host_rewrite\",\"host_rewrite\"]","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.RouteTypeSimpleWithDefaultOriginPool","properties":{"auto_host_rewrite":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_host_rewrite":{"$ref":"#/components/schemas/ioschemaEmpty"},"host_rewrite":{"type":"string","description":"Exclusive with [auto_host_rewrite disable_host_rewrite]\n Host header will be swapped with this value\n\nExample: ` \"one.volterra.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n","title":"HostRewrite","x-displayname":"Host Rewrite Value","x-ves-example":"one.volterra.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true"}},"http_method":{"$ref":"#/components/schemas/schemaHttpMethod"},"path":{"$ref":"#/components/schemas/ioschemaPathMatcherType"}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaHeaderMatcherType":{"type":"object","description":"Header match is done using the name of the header and its value.\nThe value match is done using one of the following\n    regex match on value\n    exact match of value\n    presence of header\n\nHeader Match can also be inverse of above, which be used to check\n    missing header or\n    non-matching value","title":"HeaderMatcherType","x-displayname":"Header to Match","x-ves-oneof-field-value_match":"[\"exact\",\"presence\",\"regex\"]","x-ves-proto-message":"ves.io.schema.HeaderMatcherType","properties":{"exact":{"type":"string","description":"Exclusive with [presence regex]\n Header value to match exactly\n\nExample: ` \"application/json\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"exact","maxLength":256,"x-displayname":"Exact","x-ves-example":"application/json","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"invert_match":{"type":"boolean","description":" Invert the result of the match to detect missing header or non-matching value","title":"invert_match","format":"boolean","x-displayname":"NOT of match"},"name":{"type":"string","description":" Name of the header\n\nExample: ` \"Content-Type\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.http_header_field: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":256,"x-displayname":"Name","x-ves-example":"Content-Type","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}},"presence":{"type":"boolean","description":"Exclusive with [exact regex]\n If true, check for presence of header","title":"presence","format":"boolean","x-displayname":"Presence"},"regex":{"type":"string","description":"Exclusive with [exact presence]\n Regex match of the header value in re2 format\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n  ves.io.schema.rules.string.regex: true\n","title":"regex","maxLength":256,"x-displayname":"Regex","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true","ves.io.schema.rules.string.regex":"true"}}}},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"ioschemaPathMatcherType":{"type":"object","description":"Path match of the URI can be either be, Prefix match or exact match or regular expression match","title":"PathMatcherType","x-displayname":"Path to Match","x-ves-displayorder":"4","x-ves-oneof-field-path_match":"[\"path\",\"prefix\",\"regex\"]","x-ves-proto-message":"ves.io.schema.PathMatcherType","properties":{"path":{"type":"string","description":"Exclusive with [prefix regex]\n Exact path value to match\n\nExample: ` \"/logout\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"exact","maxLength":256,"x-displayname":"Exact","x-ves-example":"/logout","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"prefix":{"type":"string","description":"Exclusive with [path regex]\n Path prefix to match (e.g. the value / will match on all paths)\n\nExample: ` \"/register/\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"prefix","maxLength":256,"x-displayname":"Prefix","x-ves-example":"/register/","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"regex":{"type":"string","description":"Exclusive with [path prefix]\n Regular expression of path match (e.g. the value .* will match on all paths)\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.regex: true\n","title":"regex","minLength":1,"maxLength":256,"x-displayname":"Regex","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.regex":"true"}}}},"ioschemaPortMatcherType":{"type":"object","description":"Port match of the request can be a range or a specific port","title":"PortMatcherType","x-displayname":"Port to Match","x-ves-displayorder":"3","x-ves-oneof-field-port_match":"[\"no_port_match\",\"port\",\"port_ranges\"]","x-ves-proto-message":"ves.io.schema.PortMatcherType","properties":{"no_port_match":{"$ref":"#/components/schemas/ioschemaEmpty"},"port":{"type":"integer","description":"Exclusive with [no_port_match port_ranges]\n Exact Port to match\n\nExample: ` \"6443\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"port","format":"int64","x-displayname":"Port","x-ves-example":"6443","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"65535"}},"port_ranges":{"type":"string","description":"Exclusive with [no_port_match port]\n Port range to match\n\nExample: ` \"8080-8191\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 32\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.port_range: true\n","title":"port_range","minLength":1,"maxLength":32,"x-displayname":"Port range","x-ves-example":"8080-8191","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"32","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.port_range":"true"}}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"routeRouteDirectResponse":{"type":"object","description":"Send this direct response in case of route match action is direct response","title":"RouteDirectResponse","x-displayname":"Direct Response","x-ves-proto-message":"ves.io.schema.route.RouteDirectResponse","properties":{"response_body_encoded":{"type":"string","description":" Response body to send. Currently supported URL schemes is string:///\n for which message should be encoded in Base64 format.\n The message can be either plain text or html.\n E.g. \"<p> Access Denied </p>\". Base64 encoded string url for this is string:///PHA+IEFjY2VzcyBEZW5pZWQgPC9wPg==\n\nExample: ` \"OK\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 65536\n  ves.io.schema.rules.string.uri_ref: true\n","title":"response_body","maxLength":65536,"x-displayname":"Response Body","x-ves-example":"OK","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"65536","ves.io.schema.rules.string.uri_ref":"true"}},"response_code":{"type":"integer","description":" response code to send\n\nExample: ` \"200\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 100\n  ves.io.schema.rules.uint32.lte: 599\n","title":"response_code","format":"int64","x-displayname":"Response Code","x-ves-example":"200","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"100","ves.io.schema.rules.uint32.lte":"599"}}}},"routeRouteQueryParams":{"type":"object","description":"x-displayName: \"Query Parameters\"\nQuery params keys to strip while manipulating the HTTP request","title":"RouteQueryParams","properties":{"query_params":{"type":"array","description":"x-displayName: \"Query Parameters\"\nx-example: \"userid\"\nQuery params keys to strip while manipulating the HTTP request","title":"query_params","items":{"type":"string"}}}},"routeRouteRedirect":{"type":"object","description":"route redirect parameters when match action is redirect.","title":"RouteRedirect","x-displayname":"Redirect","x-ves-displayorder":"3,1,10,6,7","x-ves-oneof-field-query_params":"[\"remove_all_params\",\"replace_params\",\"retain_all_params\"]","x-ves-oneof-field-redirect_path_choice":"[\"path_redirect\",\"prefix_rewrite\"]","x-ves-proto-message":"ves.io.schema.route.RouteRedirect","properties":{"host_redirect":{"type":"string","description":" swap host part of incoming URL in redirect URL\n\nExample: ` \"one.ves.io\"`","title":"host_redirect","x-displayname":"Host","x-ves-example":"one.ves.io"},"path_redirect":{"type":"string","description":"Exclusive with [prefix_rewrite]\n swap path part of incoming URL in redirect URL\n\nExample: ` \"/api/register\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"path_redirect","maxLength":256,"x-displayname":"Path","x-ves-example":"/api/register","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"prefix_rewrite":{"type":"string","description":"Exclusive with [path_redirect]\n In Redirect response, the matched prefix (or path) should be swapped with this value.\n This option allows redirect URLs be dynamically created based on the request\n\nExample: ` \"/api/register/\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"prefix_rewrite","maxLength":256,"x-displayname":"Prefix Rewrite","x-ves-example":"/api/register/","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"proto_redirect":{"type":"string","description":" swap protocol part of incoming URL in redirect URL\n The protocol can be swapped with either http or https\n When incoming-proto option is specified, swapping of protocol is not done.\n\nExample: ` \"https\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"incoming-proto\\\",\\\"http\\\",\\\"https\\\"]\n","title":"proto_redirect","x-displayname":"Protocol","x-ves-example":"https","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"incoming-proto\\\",\\\"http\\\",\\\"https\\\"]"}},"remove_all_params":{"$ref":"#/components/schemas/ioschemaEmpty"},"replace_params":{"type":"string","description":"Exclusive with [remove_all_params retain_all_params]\n\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Replace All Params","minLength":1,"maxLength":256,"x-displayname":"Replace All Parameters","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}},"response_code":{"type":"integer","description":" The HTTP status code to use in the redirect response.\n\nExample: ` \"303\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 599\n","title":"response_code","format":"int64","x-displayname":"Response Code","x-ves-example":"303","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"599"}},"retain_all_params":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaHashAlgorithm":{"type":"string","description":"Specifies the Hash Algorithm to be used\n\nInvalid hash algorithm\nsha256 hash algorithm\nsha1 hash algorithm","title":"HashAlgoritm","enum":["INVALID_HASH_ALGORITHM","SHA256","SHA1"],"default":"INVALID_HASH_ALGORITHM","x-displayname":"Hash Algorithm","x-ves-proto-enum":"ves.io.schema.HashAlgorithm"},"schemaHashAlgorithms":{"type":"object","description":"Specifies the hash algorithms to be used","title":"HashAlgorithms","x-displayname":"Hash Algorithms","x-ves-proto-message":"ves.io.schema.HashAlgorithms","properties":{"hash_algorithms":{"type":"array","description":" Ordered list of hash algorithms to be used.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Hash Algorithms","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/schemaHashAlgorithm"},"x-displayname":"Hash Algorithms","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"schemaHeaderTransformationType":{"type":"object","description":"Header Transformation options for HTTP/1.1 request/response headers","title":"HeaderTransformationType","x-displayname":"Header Transformation","x-ves-displayorder":"1","x-ves-oneof-field-header_transformation_choice":"[\"default_header_transformation\",\"legacy_header_transformation\",\"preserve_case_header_transformation\",\"proper_case_header_transformation\"]","x-ves-proto-message":"ves.io.schema.HeaderTransformationType","properties":{"default_header_transformation":{"$ref":"#/components/schemas/ioschemaEmpty"},"legacy_header_transformation":{"$ref":"#/components/schemas/ioschemaEmpty"},"preserve_case_header_transformation":{"$ref":"#/components/schemas/ioschemaEmpty"},"proper_case_header_transformation":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaHttpMethod":{"type":"string","description":"Specifies the HTTP method used to access a resource.\n\nAny HTTP Method","title":"HttpMethod","enum":["ANY","GET","HEAD","POST","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH","COPY"],"default":"ANY","x-displayname":"HTTP Method","x-ves-proto-enum":"ves.io.schema.HttpMethod"},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaKubeRefType":{"type":"object","description":"KubeRefType represents a reference to a Kubernetes (K8s) object","title":"KubeRefType","x-displayname":"Kubernetes Reference","x-ves-proto-message":"ves.io.schema.KubeRefType","properties":{"kind":{"type":"string","description":" Kind of the kubernetes object\n\nExample: ` \"Deployment\"`","title":"kind","x-displayname":"Kind","x-ves-example":"Deployment"},"name":{"type":"string","description":" Name of the kubernetes object\n\nExample: ` \"adservice\"`","title":"name","x-displayname":"Name","x-ves-example":"adservice"},"namespace":{"type":"string","description":" Namespace of the kubernetes object\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaTLSCoalescingOptions":{"type":"object","description":"TLS connection coalescing configuration (not compatible with mTLS)","title":"TLSCoalescingOptions","x-displayname":"TLS Coalescing Options","x-ves-oneof-field-coalescing_choice":"[\"default_coalescing\",\"strict_coalescing\"]","x-ves-proto-message":"ves.io.schema.TLSCoalescingOptions","properties":{"default_coalescing":{"$ref":"#/components/schemas/ioschemaEmpty"},"strict_coalescing":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaTlsCertificateType":{"type":"object","description":"Handle to fetch certificate and key","title":"TlsCertificateType","x-displayname":"TLS Certificate","x-ves-oneof-field-ocsp_stapling_choice":"[\"custom_hash_algorithms\",\"disable_ocsp_stapling\",\"use_system_defaults\"]","x-ves-proto-message":"ves.io.schema.TlsCertificateType","properties":{"certificate_url":{"type":"string","description":" TLS certificate.\n Certificate or certificate chain in PEM format including the PEM headers.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.certificate_url: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"certificate_url","minLength":1,"maxLength":131072,"x-displayname":"Certificate","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.certificate_url":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.min_bytes":"1"}},"custom_hash_algorithms":{"$ref":"#/components/schemas/schemaHashAlgorithms"},"description":{"type":"string","description":" Description for the certificate\n\nExample: ` \"Certificate used in production environment\"`","title":"description","x-displayname":"Description","x-ves-example":"Certificate used in production environment"},"disable_ocsp_stapling":{"$ref":"#/components/schemas/ioschemaEmpty"},"private_key":{"$ref":"#/components/schemas/schemaSecretType"},"use_system_defaults":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaTlsProtocol":{"type":"string","description":"TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.","title":"TlsProtocol","enum":["TLS_AUTO","TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"default":"TLS_AUTO","x-displayname":"TLS Protocol","x-ves-proto-enum":"ves.io.schema.TlsProtocol"},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemaXfccElement":{"type":"string","description":"X-Forwarded-Client-Cert custom cookie elements\n\nThe entire client certificate in URL encoded PEM format.\nThe entire client certificate chain (including the leaf certificate) in URL encoded PEM format.\nThe Subject field of the current client certificate. The value is always double-quoted.\nThe URI type Subject Alternative Name field of the current client certificate.\nA client certificate may contain multiple URI type Subject Alternative Names,\neach will be a separate key-value pair.\nThe DNS type Subject Alternative Name field of the current client certificate.\nA client certificate may contain multiple DNS type Subject Alternative Names,\neach will be a separate key-value pair.","title":"XfccElement","enum":["XFCC_NONE","XFCC_CERT","XFCC_CHAIN","XFCC_SUBJECT","XFCC_URI","XFCC_DNS"],"default":"XFCC_NONE","x-displayname":"XFCC Elements","x-ves-proto-enum":"ves.io.schema.XfccElement"},"schemaviewsDownstreamTlsParamsType":{"type":"object","description":"Inline TLS parameters","title":"DownstreamTlsParamsType","x-displayname":"Inline TLS Parameters","x-ves-oneof-field-mtls_choice":"[\"no_mtls\",\"use_mtls\"]","x-ves-proto-message":"ves.io.schema.views.DownstreamTlsParamsType","properties":{"no_mtls":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_certificates":{"type":"array","description":" Users can add one or more certificates that share the same set of domains.\n for example, domain.com and *.domain.com - but use different signature algorithms\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"tls_certificates","minItems":1,"maxItems":16,"items":{"$ref":"#/components/schemas/schemaTlsCertificateType"},"x-displayname":"TLS Certificates","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1"}},"tls_config":{"$ref":"#/components/schemas/viewsTlsConfig"},"use_mtls":{"$ref":"#/components/schemas/viewsDownstreamTlsValidationContext"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"schemavirtual_hostHttp1ProtocolOptions":{"type":"object","description":"HTTP/1.1 Protocol options for downstream connections","title":"Http1ProtocolOptions","x-displayname":"HTTP/1.1 Protocol Options","x-ves-proto-message":"ves.io.schema.virtual_host.Http1ProtocolOptions","properties":{"header_transformation":{"$ref":"#/components/schemas/schemaHeaderTransformationType"}}},"viewsCustomCiphers":{"type":"object","description":"This defines TLS protocol config including min/max versions and allowed ciphers","title":"CustomCiphers","x-displayname":"Custom Ciphers","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.views.CustomCiphers","properties":{"cipher_suites":{"type":"array","description":" The TLS listener will only support the specified cipher list.\n\nExample: ` \"TLS_AES_128_GCM_SHA256\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.in: [\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]\n  ves.io.schema.rules.repeated.unique: true\n","title":"cipher_suites","items":{"type":"string"},"x-displayname":"Cipher Suites","x-ves-example":"TLS_AES_128_GCM_SHA256","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.in":"[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]","ves.io.schema.rules.repeated.unique":"true"}},"max_version":{"$ref":"#/components/schemas/schemaTlsProtocol"},"min_version":{"$ref":"#/components/schemas/schemaTlsProtocol"}}},"viewsDownstreamTLSCertsParams":{"type":"object","description":"Select TLS Parameters and Certificates","title":"DownstreamTLSCertsParams","x-displayname":"TLS Parameters","x-ves-oneof-field-mtls_choice":"[\"no_mtls\",\"use_mtls\"]","x-ves-proto-message":"ves.io.schema.views.DownstreamTLSCertsParams","properties":{"certificates":{"type":"array","description":" Select one or more certificates with any domain names.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"certificates","maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Certificates","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}},"no_mtls":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_config":{"$ref":"#/components/schemas/viewsTlsConfig"},"use_mtls":{"$ref":"#/components/schemas/viewsDownstreamTlsValidationContext"}}},"viewsDownstreamTlsValidationContext":{"type":"object","description":"Validation context for downstream client TLS connections","title":"DownstreamTlsValidationContext","x-displayname":"Clients TLS validation context","x-ves-oneof-field-crl_choice":"[\"crl\",\"no_crl\"]","x-ves-oneof-field-trusted_ca_choice":"[\"trusted_ca\",\"trusted_ca_url\"]","x-ves-oneof-field-xfcc_header":"[\"xfcc_disabled\",\"xfcc_options\"]","x-ves-proto-message":"ves.io.schema.views.DownstreamTlsValidationContext","properties":{"client_certificate_optional":{"type":"boolean","description":" Client certificate is optional. If the client has provided a certificate,\n the load balancer will verify it. If certification verification fails,\n the connection will be terminated. If the client does not provide a certificate,\n the connection will be accepted.","title":"client_certificate_optional","format":"boolean","x-displayname":"Client Certificate Optional"},"crl":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"no_crl":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_ca":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"trusted_ca_url":{"type":"string","description":"Exclusive with [trusted_ca]\n Upload a Root CA Certificate specifically for this Load Balancer\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.truststore_url: true\n","title":"trusted_ca_url","minLength":1,"maxLength":131072,"x-displayname":"Inline Root CA Certificate (legacy)","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.truststore_url":"true"}},"xfcc_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"xfcc_options":{"$ref":"#/components/schemas/viewsXfccHeaderKeys"}}},"viewsSiteNetwork":{"type":"string","description":"This defines network types to be used on site\n\nAll inside and outside networks.\nAll inside and outside networks with internet VIP support.\nAll inside networks.\nAll outside networks.\nAll outside networks with internet VIP support.\nvK8s service network.\n - SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site\n\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network","title":"SiteNetwork","enum":["SITE_NETWORK_INSIDE_AND_OUTSIDE","SITE_NETWORK_INSIDE","SITE_NETWORK_OUTSIDE","SITE_NETWORK_SERVICE","SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP","SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP","SITE_NETWORK_IP_FABRIC"],"default":"SITE_NETWORK_INSIDE_AND_OUTSIDE","x-displayname":"Site Network","x-ves-proto-enum":"ves.io.schema.views.SiteNetwork"},"viewsTlsConfig":{"type":"object","description":"This defines various options to configure TLS configuration parameters","title":"TlsConfig","x-displayname":"TLS Config","x-ves-displayorder":"5","x-ves-oneof-field-choice":"[\"custom_security\",\"default_security\",\"low_security\",\"medium_security\"]","x-ves-proto-message":"ves.io.schema.views.TlsConfig","properties":{"custom_security":{"$ref":"#/components/schemas/viewsCustomCiphers"},"default_security":{"$ref":"#/components/schemas/ioschemaEmpty"},"low_security":{"$ref":"#/components/schemas/ioschemaEmpty"},"medium_security":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsWhereSite":{"type":"object","description":"This defines a reference to a CE site along with network type and an optional ip address where a load balancer could be advertised","title":"WhereSite","x-displayname":"Site","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.views.WhereSite","properties":{"ip":{"type":"string","description":" Use given IP address as VIP on the site\n\nExample: ` \"8.8.8.8\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IP address on the site","x-displayname":"IP Address","x-ves-example":"8.8.8.8","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"network":{"$ref":"#/components/schemas/viewsSiteNetwork"},"site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereVK8SService":{"type":"object","description":"This defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network","title":"WhereVK8SService","x-displayname":"vK8s Services on RE","x-ves-displayorder":"3","x-ves-oneof-field-choice":"[\"site\",\"virtual_site\"]","x-ves-proto-message":"ves.io.schema.views.WhereVK8SService","properties":{"site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereVirtualSite":{"type":"object","description":"This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised","title":"WhereVirtualSite","x-displayname":"Virtual Site","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.WhereVirtualSite","properties":{"network":{"$ref":"#/components/schemas/viewsSiteNetwork"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsXfccHeaderKeys":{"type":"object","description":"X-Forwarded-Client-Cert header elements to be added to requests","title":"XfccHeaderKeys","x-displayname":"XFCC Header Elements","x-ves-proto-message":"ves.io.schema.views.XfccHeaderKeys","properties":{"xfcc_header_elements":{"type":"array","description":" X-Forwarded-Client-Cert header elements to be added to requests\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n","title":"XFCC Header","items":{"$ref":"#/components/schemas/schemaXfccElement"},"x-displayname":"XFCC Header Elements","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]"}}}},"viewsworkloadCreateSpecType":{"type":"object","description":"Shape of Workload","title":"CreateSpecType","x-displayname":"Create Workload","x-ves-oneof-field-workload_choice":"[\"job\",\"service\",\"simple_service\",\"stateful_service\"]","x-ves-proto-message":"ves.io.schema.views.workload.CreateSpecType","properties":{"job":{"$ref":"#/components/schemas/workloadJobType"},"service":{"$ref":"#/components/schemas/viewsworkloadServiceType"},"simple_service":{"$ref":"#/components/schemas/workloadSimpleServiceType"},"stateful_service":{"$ref":"#/components/schemas/workloadStatefulServiceType"}}},"viewsworkloadGetSpecType":{"type":"object","description":"Shape of Workload","title":"GetSpecType","x-displayname":"Get Workload","x-ves-oneof-field-workload_choice":"[\"job\",\"service\",\"simple_service\",\"stateful_service\"]","x-ves-proto-message":"ves.io.schema.views.workload.GetSpecType","properties":{"job":{"$ref":"#/components/schemas/workloadJobType"},"service":{"$ref":"#/components/schemas/viewsworkloadServiceType"},"simple_service":{"$ref":"#/components/schemas/workloadSimpleServiceType"},"stateful_service":{"$ref":"#/components/schemas/workloadStatefulServiceType"}}},"viewsworkloadProtocolType":{"type":"string","description":"Type of protocol\n\n - PROTOCOL_TCP: TCP\n\nTCP\n - PROTOCOL_HTTP: HTTP\n\nHTTP\n - PROTOCOL_HTTP2: HTTP2\n\nHTTP2\n - PROTOCOL_TLS_WITH_SNI: TLS with SNI\n\nTLS with SNI\n - PROTOCOL_UDP: UDP\n\nUDP","title":"Protocol Type","enum":["PROTOCOL_TCP","PROTOCOL_HTTP","PROTOCOL_HTTP2","PROTOCOL_TLS_WITH_SNI","PROTOCOL_UDP"],"default":"PROTOCOL_TCP","x-displayname":"Protocol Type","x-ves-proto-enum":"ves.io.schema.views.workload.ProtocolType"},"viewsworkloadReplaceSpecType":{"type":"object","description":"Shape of Workload","title":"ReplaceSpecType","x-displayname":"Replace Workload","x-ves-oneof-field-workload_choice":"[\"job\",\"service\",\"simple_service\",\"stateful_service\"]","x-ves-proto-message":"ves.io.schema.views.workload.ReplaceSpecType","properties":{"job":{"$ref":"#/components/schemas/workloadJobType"},"service":{"$ref":"#/components/schemas/viewsworkloadServiceType"},"simple_service":{"$ref":"#/components/schemas/workloadSimpleServiceType"},"stateful_service":{"$ref":"#/components/schemas/workloadStatefulServiceType"}}},"viewsworkloadRouteType":{"type":"object","description":"This defines various options to define a route","title":"RouteType","x-displayname":"Route Type","x-ves-proto-message":"ves.io.schema.views.workload.RouteType","properties":{"routes":{"type":"array","description":" Routes for this loadbalancer\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n","title":"Routes","maxItems":32,"items":{"$ref":"#/components/schemas/workloadRouteInfoType"},"x-displayname":"Routes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32"}}}},"viewsworkloadServiceType":{"type":"object","description":"Service does not maintain per replica state, however it can be configured to use persistent\nstorage that is shared amongst all the replicas. Replicas of a service are fungible and do\nnot have a stable network identity or storage. Common examples of services are web servers,\napplication servers, traditional SQL databases, etc.","title":"ServiceType","x-displayname":"ServiceType","x-ves-oneof-field-scaling_choice":"[\"num_replicas\",\"scale_to_zero\"]","x-ves-proto-message":"ves.io.schema.views.workload.ServiceType","properties":{"advertise_options":{"$ref":"#/components/schemas/workloadAdvertiseOptionsType"},"configuration":{"$ref":"#/components/schemas/workloadConfigurationParametersType"},"containers":{"type":"array","description":" Containers to use for service\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Containers","maxItems":16,"items":{"$ref":"#/components/schemas/workloadContainerType"},"x-displayname":"Containers","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}},"deploy_options":{"$ref":"#/components/schemas/workloadDeployOptionsType"},"num_replicas":{"type":"integer","description":"Exclusive with [scale_to_zero]\n Number of replicas of service to spawn per site\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gt: 0\n  ves.io.schema.rules.int32.lte: 5\n","title":"Number of Replicas","format":"int32","x-displayname":"Number of Replicas","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.int32.gt":"0","ves.io.schema.rules.int32.lte":"5"}},"scale_to_zero":{"$ref":"#/components/schemas/ioschemaEmpty"},"volumes":{"type":"array","description":" Volumes for the service\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Volumes","maxItems":16,"items":{"$ref":"#/components/schemas/workloadStorageVolumeType"},"x-displayname":"Volumes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"virtual_hostHttpProtocolOptions":{"type":"object","description":"HTTP protocol configuration options for downstream connections","title":"HttpProtocolOptions","x-displayname":"HTTP Protocol Configuration Options","x-ves-displayorder":"1","x-ves-oneof-field-http_protocol_choice":"[\"http_protocol_enable_v1_only\",\"http_protocol_enable_v1_v2\",\"http_protocol_enable_v2_only\"]","x-ves-proto-message":"ves.io.schema.virtual_host.HttpProtocolOptions","properties":{"http_protocol_enable_v1_only":{"$ref":"#/components/schemas/schemavirtual_hostHttp1ProtocolOptions"},"http_protocol_enable_v1_v2":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_protocol_enable_v2_only":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"workloadAdvertiseCustomType":{"type":"object","description":"Advertise this workload via loadbalancer on specific sites","title":"AdvertiseCustomType","x-displayname":"Advertise on specific sites","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseCustomType","properties":{"advertise_where":{"type":"array","description":" Where should this load balancer be available\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Advertise Where","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/workloadAdvertiseWhereType"},"x-displayname":"List of Sites to Advertise","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"ports":{"type":"array","description":" Ports to advertise\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Ports","maxItems":16,"items":{"$ref":"#/components/schemas/workloadAdvertisePortType"},"x-displayname":"Ports","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}}}},"workloadAdvertiseInClusterType":{"type":"object","description":"Advertise the workload locally in-cluster","title":"AdvertiseInClusterType","x-displayname":"Advertise In Cluster","x-ves-oneof-field-port_choice":"[\"multi_ports\",\"port\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseInClusterType","properties":{"multi_ports":{"$ref":"#/components/schemas/workloadMultiPortType"},"port":{"$ref":"#/components/schemas/workloadSinglePortType"}}},"workloadAdvertiseMultiPortType":{"type":"object","description":"Advertise multiple ports","title":"AdvertiseMultiPortType","x-displayname":"Advertise Multiple Ports","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseMultiPortType","properties":{"ports":{"type":"array","description":" Ports to advertise\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Ports","maxItems":16,"items":{"$ref":"#/components/schemas/workloadAdvertisePortType"},"x-displayname":"Ports","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}}}},"workloadAdvertiseOptionsType":{"type":"object","description":"\nAdvertise options are used to configure how and where to advertise the workload using load balancers","title":"Advertise Options","x-displayname":"Advertise Options","x-ves-oneof-field-advertise_choice":"[\"advertise_custom\",\"advertise_in_cluster\",\"advertise_on_public\",\"do_not_advertise\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseOptionsType","properties":{"advertise_custom":{"$ref":"#/components/schemas/workloadAdvertiseCustomType"},"advertise_in_cluster":{"$ref":"#/components/schemas/workloadAdvertiseInClusterType"},"advertise_on_public":{"$ref":"#/components/schemas/workloadAdvertisePublicType"},"do_not_advertise":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"workloadAdvertisePortType":{"type":"object","description":"Advertise port","title":"AdvertisePortType","x-displayname":"Advertise Port","x-ves-oneof-field-advertise_choice":"[\"http_loadbalancer\",\"tcp_loadbalancer\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertisePortType","properties":{"http_loadbalancer":{"$ref":"#/components/schemas/workloadHTTPLoadBalancerType"},"port":{"$ref":"#/components/schemas/workloadPortType"},"tcp_loadbalancer":{"$ref":"#/components/schemas/workloadTCPLoadBalancerType"}}},"workloadAdvertisePublicType":{"type":"object","description":"Advertise this workload via loadbalancer on Internet with default VIP","title":"AdvertisePublicType","x-displayname":"Advertise On Internet","x-ves-oneof-field-advertise_choice":"[\"multi_ports\",\"port\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertisePublicType","properties":{"multi_ports":{"$ref":"#/components/schemas/workloadAdvertiseMultiPortType"},"port":{"$ref":"#/components/schemas/workloadAdvertiseSinglePortType"}}},"workloadAdvertiseSimpleServiceType":{"type":"object","description":"Advertise options for Simple Service","title":"AdvertiseSimpleServiceType","x-displayname":"Advertise Options For Simple Service","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseSimpleServiceType","properties":{"domains":{"type":"array","description":" A list of Domains (host/authority header) that will be matched to Load Balancer.\n Wildcard hosts are supported in the suffix or prefix form\n\n Supported Domains and search order:\n  1. Exact Domain names: www.foo.com.\n  2. Domains starting with a Wildcard: *.foo.com.\n\n Not supported Domains:\n - Just a Wildcard: *\n - A Wildcard and TLD with no root Domain: *.com.\n - A Wildcard not matching a whole DNS label.\n e.g. *.foo.com and *.bar.foo.com are valid Wildcards however *bar.foo.com, *-bar.foo.com, and bar*.foo.com are all invalid.\n\n Additional notes:\n A Wildcard will not match empty string.\n e.g. *.foo.com will match bar.foo.com and baz-bar.foo.com but not .foo.com.\n The longest Wildcards match first.\n Only a single virtual host in the entire route configuration can match on *.\n Also a Domain must be unique across all virtual hosts within an advertise policy.\n\n Domains are also used for SNI matching if the Load Balancer type is HTTPS.\n Domains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.\n\nExample: ` \"www.foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.items.string.vh_domain: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domains","minItems":1,"maxItems":32,"items":{"type":"string","minLength":1,"maxLength":256},"x-displayname":"Domains","x-ves-example":"www.foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.items.string.vh_domain":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"service_port":{"type":"integer","description":" Service port to advertise on Internet via HTTP loadbalancer using port 80\n\nExample: ` \"2048\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1024\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Service Port","format":"int64","x-displayname":"Service Port","x-ves-example":"2048","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1024","ves.io.schema.rules.uint32.lte":"65535"}}}},"workloadAdvertiseSinglePortType":{"type":"object","description":"Advertise single port","title":"AdvertiseSinglePortType","x-displayname":"Advertise Port","x-ves-oneof-field-advertise_choice":"[\"http_loadbalancer\",\"tcp_loadbalancer\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseSinglePortType","properties":{"http_loadbalancer":{"$ref":"#/components/schemas/workloadHTTPLoadBalancerType"},"port":{"$ref":"#/components/schemas/workloadSinglePortType"},"tcp_loadbalancer":{"$ref":"#/components/schemas/workloadTCPLoadBalancerType"}}},"workloadAdvertiseWhereType":{"type":"object","description":"This defines various options where a load balancer could be advertised","title":"AdvertiseWhereType","x-displayname":"Select Where to Advertise","x-ves-oneof-field-choice":"[\"site\",\"virtual_site\",\"vk8s_service\"]","x-ves-proto-message":"ves.io.schema.views.workload.AdvertiseWhereType","properties":{"site":{"$ref":"#/components/schemas/viewsWhereSite"},"virtual_site":{"$ref":"#/components/schemas/viewsWhereVirtualSite"},"vk8s_service":{"$ref":"#/components/schemas/viewsWhereVK8SService"}}},"workloadConfigurationFileType":{"type":"object","description":"Configuration File for the workload","title":"ConfigurationFileType","x-displayname":"Configuration File","x-ves-proto-message":"ves.io.schema.views.workload.ConfigurationFileType","properties":{"data":{"type":"string","description":" File data\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 16384\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Data","maxLength":16384,"x-displayname":"Data","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"16384","ves.io.schema.rules.string.uri_ref":"true"}},"mount":{"$ref":"#/components/schemas/workloadVolumeMountType"},"name":{"type":"string","description":" Name of the file\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Name","maxLength":256,"x-displayname":"Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"volume_name":{"type":"string","description":" Name of the Volume\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"VolumeName","maxLength":256,"x-displayname":"Volume Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}}}},"workloadConfigurationParameterType":{"type":"object","description":"Configuration parameter for the workload","title":"ConfigurationParameterType","x-displayname":"Configuration Parameter","x-ves-oneof-field-choice":"[\"env_var\",\"file\"]","x-ves-proto-message":"ves.io.schema.views.workload.ConfigurationParameterType","properties":{"env_var":{"$ref":"#/components/schemas/workloadEnvironmentVariableType"},"file":{"$ref":"#/components/schemas/workloadConfigurationFileType"}}},"workloadConfigurationParametersType":{"type":"object","description":"Configuration parameters of the workload","title":"ConfigurationParametersType","x-displayname":"Configuration Parameters","x-ves-proto-message":"ves.io.schema.views.workload.ConfigurationParametersType","properties":{"parameters":{"type":"array","description":" Parameters for the workload\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"Parameters","maxItems":32,"items":{"$ref":"#/components/schemas/workloadConfigurationParameterType"},"x-displayname":"Parameters","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadContainerFlavorType":{"type":"string","description":"Container Flavor type\n\n - CONTAINER_FLAVOR_TYPE_TINY: Tiny\n\nTiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory\n - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium\n\nMedium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory\n - CONTAINER_FLAVOR_TYPE_LARGE: Large\n\nLarge containers have limit of 1 vCPU and 2048 MiB (mebibyte) memory","title":"ContainerFlavorType","enum":["CONTAINER_FLAVOR_TYPE_TINY","CONTAINER_FLAVOR_TYPE_MEDIUM","CONTAINER_FLAVOR_TYPE_LARGE"],"default":"CONTAINER_FLAVOR_TYPE_TINY","x-displayname":"Container Flavor Type","x-ves-proto-enum":"ves.io.schema.views.workload.ContainerFlavorType"},"workloadContainerType":{"type":"object","description":"ContainerType configures the container information","title":"ContainerType","x-displayname":"Container Configuration","x-ves-oneof-field-flavor_choice":"[\"custom_flavor\",\"default_flavor\",\"flavor\"]","x-ves-proto-message":"ves.io.schema.views.workload.ContainerType","properties":{"args":{"type":"array","description":" Arguments to the entrypoint. Overrides the docker image's CMD\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n","title":"Args","maxItems":128,"items":{"type":"string"},"x-displayname":"Arguments","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128"}},"command":{"type":"array","description":" Command to execute. Overrides the docker image's ENTRYPOINT\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n","title":"Command","maxItems":128,"items":{"type":"string"},"x-displayname":"Command","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128"}},"custom_flavor":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"default_flavor":{"$ref":"#/components/schemas/ioschemaEmpty"},"flavor":{"$ref":"#/components/schemas/workloadContainerFlavorType"},"image":{"$ref":"#/components/schemas/workloadImageType"},"init_container":{"type":"boolean","description":" Specialized container that runs before application container and runs to completion","title":"Init Container","format":"boolean","x-displayname":"Initialization Container"},"liveness_check":{"$ref":"#/components/schemas/workloadHealthCheckType"},"name":{"type":"string","description":" Name of the container\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Name","maxLength":256,"x-displayname":"Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"readiness_check":{"$ref":"#/components/schemas/workloadHealthCheckType"}}},"workloadCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of workload","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.views.workload.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/viewsworkloadCreateSpecType"}}},"workloadCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.workload.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/viewsworkloadGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"workloadDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a workload","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.views.workload.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"workloadDeployCESiteType":{"type":"object","description":"This defines a way to deploy a workload on specific Customer sites","title":"DeployCESiteType","x-displayname":"Customer Sites","x-ves-proto-message":"ves.io.schema.views.workload.DeployCESiteType","properties":{"site":{"type":"array","description":" Which customer sites should this workload be deployed\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Site","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"List of Customer Sites to Deploy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadDeployCEVirtualSiteType":{"type":"object","description":"This defines a way to deploy a workload on specific Customer virtual sites","title":"DeployCEVirtualSiteType","x-displayname":"Customer Virtual Sites","x-ves-proto-message":"ves.io.schema.views.workload.DeployCEVirtualSiteType","properties":{"virtual_site":{"type":"array","description":" Which customer virtual sites should this workload be deployed\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Virtual Site","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"List of Customer Virtual Sites to Deploy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadDeployOptionsType":{"type":"object","description":"Deploy Options are used to configure the workload deployment options","title":"DeployOptionsType","x-displayname":"Deploy Options","x-ves-oneof-field-deploy_choice":"[\"all_res\",\"default_virtual_sites\",\"deploy_ce_sites\",\"deploy_ce_virtual_sites\",\"deploy_re_sites\",\"deploy_re_virtual_sites\"]","x-ves-proto-message":"ves.io.schema.views.workload.DeployOptionsType","properties":{"all_res":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_virtual_sites":{"$ref":"#/components/schemas/ioschemaEmpty"},"deploy_ce_sites":{"$ref":"#/components/schemas/workloadDeployCESiteType"},"deploy_ce_virtual_sites":{"$ref":"#/components/schemas/workloadDeployCEVirtualSiteType"},"deploy_re_sites":{"$ref":"#/components/schemas/workloadDeployRESiteType"},"deploy_re_virtual_sites":{"$ref":"#/components/schemas/workloadDeployREVirtualSiteType"}}},"workloadDeployRESiteType":{"type":"object","description":"This defines a way to deploy a workload on specific Regional Edge sites","title":"DeployRESiteType","x-displayname":"Regional Edge Sites","x-ves-proto-message":"ves.io.schema.views.workload.DeployRESiteType","properties":{"site":{"type":"array","description":" Which regional edge sites should this workload be deployed\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Site","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"List of Regional Edge Sites to Deploy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadDeployREVirtualSiteType":{"type":"object","description":"This defines a way to deploy a workload on specific Regional Edge virtual sites","title":"DeployREVirtualSiteType","x-displayname":"Regional Edge Virtual Sites","x-ves-proto-message":"ves.io.schema.views.workload.DeployREVirtualSiteType","properties":{"virtual_site":{"type":"array","description":" Which regional edge virtual sites should this workload be deployed\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Virtual Site","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"List of Regional Edge Virtual Sites to Deploy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadEmptyDirectoryVolumeType":{"type":"object","description":"Volume containing a temporary directory whose lifetime is the same as a replica of a workload","title":"EmptyDirectoryVolumeType","x-displayname":"Empty Directory Volume","x-ves-proto-message":"ves.io.schema.views.workload.EmptyDirectoryVolumeType","properties":{"mount":{"$ref":"#/components/schemas/workloadVolumeMountType"},"size_limit":{"type":"number","description":"\nExample: ` \"32\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.double.lte: 10\n  ves.io.schema.rules.message.required: true\n","title":"Size","format":"double","x-displayname":"Size Limit (in GiB)","x-ves-example":"32","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.double.lte":"10","ves.io.schema.rules.message.required":"true"}}}},"workloadEnvironmentVariableType":{"type":"object","description":"Environment Variable","title":"EnvironmentVariableType","x-displayname":"Environment Variable","x-ves-proto-message":"ves.io.schema.views.workload.EnvironmentVariableType","properties":{"name":{"type":"string","description":" Name of Environment Variable.\n\nExample: ` \"LOG_LEVEL\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Name","maxLength":256,"x-displayname":"Name","x-ves-example":"LOG_LEVEL","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"value":{"type":"string","description":" Value of Environment Variable.\n\nExample: ` \"INFO\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Value","maxLength":256,"x-displayname":"Value","x-ves-example":"INFO","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}}}},"workloadEphemeralStorageVolumeType":{"type":"object","description":"Ephemeral storage volume configuration for the workload","title":"EphemeralStorageVolumeType","x-displayname":"Ephemeral Storage Volume","x-ves-oneof-field-volume_choice":"[\"empty_dir\",\"host_path\"]","x-ves-proto-message":"ves.io.schema.views.workload.EphemeralStorageVolumeType","properties":{"empty_dir":{"$ref":"#/components/schemas/workloadEmptyDirectoryVolumeType"},"host_path":{"$ref":"#/components/schemas/workloadHostPathVolumeType"},"name":{"type":"string","description":" Name of the volume\n\nExample: ` \"volume-0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.dns_1123_label: true\n","title":"Name","x-displayname":"Name","x-ves-example":"volume-0","x-ves-validation-rules":{"ves.io.schema.rules.string.dns_1123_label":"true"}}}},"workloadExecHealthCheckType":{"type":"object","description":"ExecHealthCheckType describes a health check based on \"run in container\" action.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.","title":"ExecHealthCheckType","x-displayname":"Exec Health Check","x-ves-proto-message":"ves.io.schema.views.workload.ExecHealthCheckType","properties":{"command":{"type":"array","description":" Command is the command line to execute inside the container, the working directory for the\n command  is root ('/') in the container's filesystem. The command is simply exec'd, it is\n not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\n a shell, you need to explicitly call out to that shell.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 64\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"Command","maxItems":16,"items":{"type":"string","minLength":1,"maxLength":64},"x-displayname":"Command","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"64","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}}}},"workloadGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read workload","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.workload.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/workloadCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/workloadReplaceRequest"},"spec":{"$ref":"#/components/schemas/viewsworkloadGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/workloadStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"workloadGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"workloadHTTPHealthCheckType":{"type":"object","description":"HTTPHealthCheckType describes a health check based on HTTP GET requests.","title":"HTTPHealthCheckType","x-displayname":"HTTP Health Check","x-ves-proto-message":"ves.io.schema.views.workload.HTTPHealthCheckType","properties":{"headers":{"type":"object","description":" Specifies a list of HTTP headers that should be added to each request that is sent to the\n health checked container. This is a list of key-value pairs.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 256\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 16\n  ves.io.schema.rules.map.values.string.max_len: 2048\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"Headers to add in health check request","x-displayname":"Request Headers to Add","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"256","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"16","ves.io.schema.rules.map.values.string.max_len":"2048","ves.io.schema.rules.map.values.string.min_len":"1"}},"host_header":{"type":"string","description":" The value of the host header in the HTTP health check request.\n\nExample: ` \"one.volterra.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostport: true\n  ves.io.schema.rules.string.max_len: 262\n","title":"Host Header","maxLength":262,"x-displayname":"Host Header","x-ves-example":"one.volterra.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostport":"true","ves.io.schema.rules.string.max_len":"262"}},"path":{"type":"string","description":" Path to access on the HTTP server.\n\nExample: ` \"/\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 2048\n","title":"Path","maxLength":2048,"x-displayname":"Path","x-ves-example":"/","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"2048"}},"port":{"$ref":"#/components/schemas/workloadPortChoiceType"}}},"workloadHTTPLoadBalancerType":{"type":"object","description":"\nHTTP/HTTPS Load balancer","title":"HTTP/HTTPS Load balancer","x-displayname":"HTTP/HTTPS Load Balancer","x-ves-oneof-field-loadbalancer_type":"[\"http\",\"https\",\"https_auto_cert\"]","x-ves-oneof-field-route_choice":"[\"default_route\",\"specific_routes\"]","x-ves-proto-message":"ves.io.schema.views.workload.HTTPLoadBalancerType","properties":{"default_route":{"$ref":"#/components/schemas/workloadMatchAllRouteType"},"domains":{"type":"array","description":" A list of domains (host/authority header) that will be matched to loadbalancer.\n Wildcard hosts are supported in the suffix or prefix form\n\n Domain search order:\n  1. Exact domain names: ``www.foo.com``.\n  2. Prefix domain wildcards: ``*.foo.com`` or ``*.bar.foo.com``.\n  3. Special wildcard ``*`` matching any domain.\n\n Wildcard will not match empty string.\n e.g. ``*.foo.com`` will match ``bar.foo.com`` and ``baz-bar.foo.com`` but not ``.foo.com``.\n The longest wildcards match first.\n Wildcards must match a whole DNS label.\n e.g. ``*.foo.com`` and *.bar.foo.com are valid, however ``*bar.foo.com`` or ``*-bar.foo.com`` is invalid\n\n Domains are also used for SNI matching if the loadbalancer type is HTTPS\n Domains also indicate the list of names for which DNS resolution will be done by VER\n\nExample: ` \"www.foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.items.string.vh_domain: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domains","minItems":1,"maxItems":32,"items":{"type":"string","minLength":1,"maxLength":256},"x-displayname":"Domains","x-ves-example":"www.foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.items.string.vh_domain":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"http":{"$ref":"#/components/schemas/http_loadbalancerProxyTypeHttp"},"https":{"$ref":"#/components/schemas/http_loadbalancerProxyTypeHttps"},"https_auto_cert":{"$ref":"#/components/schemas/http_loadbalancerProxyTypeHttpsAutoCerts"},"specific_routes":{"$ref":"#/components/schemas/viewsworkloadRouteType"}}},"workloadHealthCheckType":{"type":"object","description":"HealthCheckType describes a health check to be performed against a container to determine whether it has\nstarted up or is alive or ready to receive traffic","title":"HealthCheckType","x-displayname":"Health Check","x-ves-oneof-field-health_check_choice":"[\"exec_health_check\",\"http_health_check\",\"tcp_health_check\"]","x-ves-proto-message":"ves.io.schema.views.workload.HealthCheckType","properties":{"exec_health_check":{"$ref":"#/components/schemas/workloadExecHealthCheckType"},"healthy_threshold":{"type":"integer","description":" Number of consecutive successful responses after having failed before declaring healthy.\n In other words, this is the number of healthy health checks required before marking\n healthy. Note that during startup and liveliness, only a single successful health check is\n required to mark a container healthy.\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","title":"HealthyThreshold","format":"int64","x-displayname":"Healthy Threshold","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}},"http_health_check":{"$ref":"#/components/schemas/workloadHTTPHealthCheckType"},"initial_delay":{"type":"integer","description":" Number of seconds after the container has started before health checks are initiated\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 600\n","title":"InitialDelay","format":"int64","x-displayname":"Initial Delay","x-ves-example":"30","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"600"}},"interval":{"type":"integer","description":" Time interval in seconds between two health check requests.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","title":"Interval","format":"int64","x-displayname":"Interval","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"tcp_health_check":{"$ref":"#/components/schemas/workloadTCPHealthCheckType"},"timeout":{"type":"integer","description":" Timeout in seconds to wait for successful response. In other words, it is\n the time to wait for a health check response. If the timeout is reached the\n health check attempt will be considered a failure.\n\nExample: ` \"3\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","title":"Timeout","format":"int64","x-displayname":"Timeout","x-ves-example":"3","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"unhealthy_threshold":{"type":"integer","description":" Number of consecutive failed responses before declaring unhealthy. In other words, this is\n the number of unhealthy health checks required before a container is marked unhealthy.\n\nExample: ` \"5\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","title":"UnhealthyThreshold","format":"int64","x-displayname":"Unhealthy Threshold","x-ves-example":"5","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}}}},"workloadHostPathVolumeType":{"type":"object","description":"Volume containing a host mapped path into the workload","title":"HostPathVolumeType","x-displayname":"HostPath Volume","x-ves-proto-message":"ves.io.schema.views.workload.HostPathVolumeType","properties":{"mount":{"$ref":"#/components/schemas/workloadVolumeMountType"},"path":{"type":"string","description":" Path of the directory on the host\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.pattern: [^\\\\0]+\n","title":"Path","maxLength":256,"x-displayname":"Path","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.pattern":"[^\\\\0]+"}}}},"workloadIPFamilyType":{"type":"object","description":"x-displayName: \"IP Family Type\"","title":"IPFamilyType","properties":{"dual_v4_preferred":{"$ref":"#/components/schemas/ioschemaEmpty"},"dual_v6_preferred":{"$ref":"#/components/schemas/ioschemaEmpty"},"v4":{"$ref":"#/components/schemas/ioschemaEmpty"},"v6":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"workloadImagePullPolicyType":{"type":"string","description":"Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload\n\n - IMAGE_PULL_POLICY_DEFAULT: Default\n\nDefault will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only if it\ndoes not already exist on the node\n - IMAGE_PULL_POLICY_IF_NOT_PRESENT: IfNotPresent\n\nOnly pull the image if it does not already exist on the node\n - IMAGE_PULL_POLICY_ALWAYS: Always\n\nAlways pull the image\n - IMAGE_PULL_POLICY_NEVER: Never\n\nNever pull the image","title":"ImagePullPolicyType","enum":["IMAGE_PULL_POLICY_DEFAULT","IMAGE_PULL_POLICY_IF_NOT_PRESENT","IMAGE_PULL_POLICY_ALWAYS","IMAGE_PULL_POLICY_NEVER"],"default":"IMAGE_PULL_POLICY_DEFAULT","x-displayname":"Image Pull Policy Type","x-ves-proto-enum":"ves.io.schema.views.workload.ImagePullPolicyType"},"workloadImageType":{"type":"object","description":"ImageType configures the image to use, how to pull the image, and the associated secrets to use if any","title":"ImageType","x-displayname":"Image Configuration","x-ves-oneof-field-registry_choice":"[\"container_registry\",\"public\"]","x-ves-proto-message":"ves.io.schema.views.workload.ImageType","properties":{"container_registry":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"name":{"type":"string","description":" Name is a container image which are usually given a name such as alpine, ubuntu, or quay.io/etcd:0.13.\n The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the\n Docker public registry is assumed. If tag is not specified, latest is assumed.\n\nExample: ` \"quay.io/etcd:0.13\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Name","maxLength":256,"x-displayname":"Image Name","x-ves-example":"quay.io/etcd:0.13","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"public":{"$ref":"#/components/schemas/ioschemaEmpty"},"pull_policy":{"$ref":"#/components/schemas/workloadImagePullPolicyType"}}},"workloadJobType":{"type":"object","description":"Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks\nlike report generation, billing, parallel data processing, ETL processing, etc.","title":"JobType","x-displayname":"Job Type","x-ves-proto-message":"ves.io.schema.views.workload.JobType","properties":{"configuration":{"$ref":"#/components/schemas/workloadConfigurationParametersType"},"containers":{"type":"array","description":" Containers to use for the job\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Containers","maxItems":16,"items":{"$ref":"#/components/schemas/workloadContainerType"},"x-displayname":"Containers","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}},"deploy_options":{"$ref":"#/components/schemas/workloadDeployOptionsType"},"num_replicas":{"type":"integer","description":" Number of replicas of the batch job to spawn per site\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.lte: 5\n","title":"Number of Replicas","format":"int32","x-displayname":"Number of Replicas","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.int32.lte":"5"}},"volumes":{"type":"array","description":" Volumes for the job\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Volumes","maxItems":16,"items":{"$ref":"#/components/schemas/workloadStorageVolumeType"},"x-displayname":"Volumes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"workloadListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of workload","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.views.workload.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/workloadListResponseItem"},"x-displayname":"Items"}}},"workloadListResponseItem":{"type":"object","description":"By default a summary of workload is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of workload","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.views.workload.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this workload","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this workload","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates workload is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/viewsworkloadGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this workload","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this workload\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/workloadStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this workload\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"workloadMatchAllRouteType":{"type":"object","description":"Default route matching all APIs","title":"MatchAllRouteType","x-displayname":"Default Route","x-ves-oneof-field-host_rewrite_params":"[\"auto_host_rewrite\",\"disable_host_rewrite\",\"host_rewrite\"]","x-ves-proto-message":"ves.io.schema.views.workload.MatchAllRouteType","properties":{"auto_host_rewrite":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_host_rewrite":{"$ref":"#/components/schemas/ioschemaEmpty"},"host_rewrite":{"type":"string","description":"Exclusive with [auto_host_rewrite disable_host_rewrite]\n Host header will be swapped with this value\n\nExample: ` \"one.volterra.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n","title":"HostRewrite","x-displayname":"Host Rewrite Value","x-ves-example":"one.volterra.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true"}}}},"workloadMultiPortType":{"type":"object","description":"Multiple ports","title":"MultiPortType","x-displayname":"Multiple Ports","x-ves-proto-message":"ves.io.schema.views.workload.MultiPortType","properties":{"ports":{"type":"array","description":" Ports to advertise\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Ports","maxItems":16,"items":{"$ref":"#/components/schemas/workloadPortType"},"x-displayname":"Ports","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}}}},"workloadPersistentStorageAccessModeType":{"type":"string","description":"Persistence storage access mode is used to configure access mode for persistent storage\n\n - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once\n\nRead Write Once is used to mount persistent storage in read/write mode to exactly 1 host\n - ACCESS_MODE_READ_WRITE_MANY: Read Write Many\n\nRead Write Many is used to mount persistent storage in read/write mode to many hosts\n - ACCESS_MODE_READ_ONLY_MANY: Read Only Many\n\nRead Only Many is used to mount persistent storage in read-only mode to many hosts","title":"PersistentStorageAccessModeType","enum":["ACCESS_MODE_READ_WRITE_ONCE","ACCESS_MODE_READ_WRITE_MANY","ACCESS_MODE_READ_ONLY_MANY"],"default":"ACCESS_MODE_READ_WRITE_ONCE","x-displayname":"Persistent Storage Access Mode","x-ves-proto-enum":"ves.io.schema.views.workload.PersistentStorageAccessModeType"},"workloadPersistentStorageType":{"type":"object","description":"Persistent storage configuration is used to configure Persistent Volume Claim (PVC)","title":"PersistentStorageType","x-displayname":"Persistence Storage Configuration","x-ves-displayorder":"2,3,1","x-ves-oneof-field-class_name_choice":"[\"class_name\",\"default\"]","x-ves-proto-message":"ves.io.schema.views.workload.PersistentStorageType","properties":{"access_mode":{"$ref":"#/components/schemas/workloadPersistentStorageAccessModeType"},"class_name":{"type":"string","description":"Exclusive with [default]\n Use the specified class name\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Class Name","maxLength":256,"x-displayname":"Class Name","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"default":{"$ref":"#/components/schemas/ioschemaEmpty"},"storage_size":{"type":"number","description":" Size in GiB of the persistent storage\n\nExample: ` \"100\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.double.gte: 0.004\n  ves.io.schema.rules.double.lte: 256\n  ves.io.schema.rules.message.required: true\n","title":"Size (in GiB)","format":"double","x-displayname":"Size (in GiB)","x-ves-example":"100","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.double.gte":"0.004","ves.io.schema.rules.double.lte":"256","ves.io.schema.rules.message.required":"true"}}}},"workloadPersistentStorageVolumeType":{"type":"object","description":"Volume containing the Persistent Storage for the workload","title":"PersistentStorageVolumeType","x-displayname":"Persistent Storage Volume","x-ves-proto-message":"ves.io.schema.views.workload.PersistentStorageVolumeType","properties":{"mount":{"$ref":"#/components/schemas/workloadVolumeMountType"},"storage":{"$ref":"#/components/schemas/workloadPersistentStorageType"}}},"workloadPersistentVolumeType":{"type":"object","description":"Persistent storage volume configuration for the workload","title":"PersistentVolumeType","x-displayname":"Persistent Storage Volume","x-ves-proto-message":"ves.io.schema.views.workload.PersistentVolumeType","properties":{"name":{"type":"string","description":" Name of the volume\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.dns_1123_label: true\n","title":"Name","x-displayname":"Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.dns_1123_label":"true"}},"persistent_volume":{"$ref":"#/components/schemas/workloadPersistentStorageVolumeType"}}},"workloadPortChoiceType":{"type":"object","description":"Port","title":"PortChoiceType","x-displayname":"Port","x-ves-oneof-field-port_choice":"[\"name\",\"num\"]","x-ves-proto-message":"ves.io.schema.views.workload.PortChoiceType","properties":{"name":{"type":"string","description":"Exclusive with [num]\n Port Name\n\nValidation Rules:\n  ves.io.schema.rules.string.iana_svc_name: true\n","title":"Name","x-displayname":"Port Name","x-ves-validation-rules":{"ves.io.schema.rules.string.iana_svc_name":"true"}},"num":{"type":"integer","description":"Exclusive with [name]\n Port number\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Number","format":"int64","x-displayname":"Port Number","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}}}},"workloadPortInfoType":{"type":"object","description":"Port information","title":"PortInfoType","x-displayname":"Port Information","x-ves-displayorder":"1,2,3","x-ves-oneof-field-target_port_choice":"[\"same_as_port\",\"target_port\"]","x-ves-proto-message":"ves.io.schema.views.workload.PortInfoType","properties":{"port":{"type":"integer","description":" Port the workload can be reached on\n\nExample: ` \"80\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port","format":"int64","x-displayname":"Port","x-ves-example":"80","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"65535"}},"protocol":{"$ref":"#/components/schemas/viewsworkloadProtocolType"},"same_as_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"target_port":{"type":"integer","description":"Exclusive with [same_as_port]\n Port the workload is listening on\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port","format":"int64","x-displayname":"Different than Port","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"65535"}}}},"workloadPortType":{"type":"object","description":"Port of the workload","title":"PortType","x-displayname":"Port","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.workload.PortType","properties":{"info":{"$ref":"#/components/schemas/workloadPortInfoType"},"name":{"type":"string","description":" Name of the Port\n\nExample: ` \"https\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.iana_svc_name: true\n","title":"Name","x-displayname":"Name","x-ves-example":"https","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.iana_svc_name":"true"}}}},"workloadReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a workload","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.views.workload.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/viewsworkloadReplaceSpecType"}}},"workloadReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.workload.ReplaceResponse"},"workloadRouteInfoType":{"type":"object","description":"This defines various options to define a route","title":"RouteInfoType","x-displayname":"Route Information","x-ves-oneof-field-choice":"[\"custom_route_object\",\"direct_response_route\",\"redirect_route\",\"simple_route\"]","x-ves-proto-message":"ves.io.schema.views.workload.RouteInfoType","properties":{"custom_route_object":{"$ref":"#/components/schemas/http_loadbalancerRouteTypeCustomRoute"},"direct_response_route":{"$ref":"#/components/schemas/http_loadbalancerRouteTypeDirectResponse"},"redirect_route":{"$ref":"#/components/schemas/http_loadbalancerRouteTypeRedirect"},"simple_route":{"$ref":"#/components/schemas/http_loadbalancerRouteTypeSimpleWithDefaultOriginPool"}}},"workloadSimpleServiceType":{"type":"object","description":"SimpleService is a service having one container and one replica that is\ndeployed on all Regional Edges and advertised on Internet via HTTP loadbalancer\non default VIP","title":"SimpleServiceType","x-displayname":"SimpleServiceType","x-ves-oneof-field-advertise_choice":"[\"do_not_advertise\",\"simple_advertise\"]","x-ves-oneof-field-persistence_choice":"[\"disabled\",\"enabled\"]","x-ves-proto-message":"ves.io.schema.views.workload.SimpleServiceType","properties":{"configuration":{"$ref":"#/components/schemas/workloadConfigurationParametersType"},"container":{"$ref":"#/components/schemas/workloadContainerType"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"do_not_advertise":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled":{"$ref":"#/components/schemas/workloadPersistentVolumeType"},"scale_to_zero":{"type":"boolean","description":" Scale down replicas of the service to zero","title":"Scale down to zero","format":"boolean","x-displayname":"Scale Down to Zero"},"simple_advertise":{"$ref":"#/components/schemas/workloadAdvertiseSimpleServiceType"}}},"workloadSinglePortType":{"type":"object","description":"Single port","title":"SinglePortType","x-displayname":"Port","x-ves-proto-message":"ves.io.schema.views.workload.SinglePortType","properties":{"info":{"$ref":"#/components/schemas/workloadPortInfoType"}}},"workloadStatefulServiceType":{"type":"object","description":"StatefulService maintains per replica state and each replica has its own persistent storage. Each replica\nhas a unique network identity and stable storage. Stateful service are used for distributed stateful\napplications like cassandra, mongodb, redis, etc.","title":"StatefulServiceType","x-displayname":"StatefulServiceType","x-ves-oneof-field-scaling_choice":"[\"num_replicas\",\"scale_to_zero\"]","x-ves-proto-message":"ves.io.schema.views.workload.StatefulServiceType","properties":{"advertise_options":{"$ref":"#/components/schemas/workloadAdvertiseOptionsType"},"configuration":{"$ref":"#/components/schemas/workloadConfigurationParametersType"},"containers":{"type":"array","description":" Containers to use for service\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Containers","maxItems":16,"items":{"$ref":"#/components/schemas/workloadContainerType"},"x-displayname":"Containers","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}},"deploy_options":{"$ref":"#/components/schemas/workloadDeployOptionsType"},"num_replicas":{"type":"integer","description":"Exclusive with [scale_to_zero]\n Number of replicas of service to spawn per site\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gt: 0\n  ves.io.schema.rules.int32.lte: 5\n","title":"Number of Replicas","format":"int32","x-displayname":"Number of Replicas","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.int32.gt":"0","ves.io.schema.rules.int32.lte":"5"}},"persistent_volumes":{"type":"array","description":" Persistent storage configuration for the service\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Persistence","maxItems":16,"items":{"$ref":"#/components/schemas/workloadPersistentVolumeType"},"x-displayname":"Persistent Storage Configuration","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}},"scale_to_zero":{"$ref":"#/components/schemas/ioschemaEmpty"},"volumes":{"type":"array","description":" Ephemeral volumes for the service\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Ephemeral Storage Volumes","maxItems":16,"items":{"$ref":"#/components/schemas/workloadEphemeralStorageVolumeType"},"x-displayname":"Ephemeral Volumes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"workloadStatusObject":{"type":"object","description":"Most recently observed status of the workload","title":"Status of Workload","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.views.workload.StatusObject","properties":{"child_objects":{"type":"array","description":" Reference to Child Kubernetes Objects","title":"child_objects","items":{"$ref":"#/components/schemas/schemaKubeRefType"},"x-displayname":"Child Kubernetes Objects"},"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"workloadStorageVolumeType":{"type":"object","description":"Storage volume configuration for the workload","title":"StorageVolumeType","x-displayname":"Storage Volume","x-ves-oneof-field-volume_choice":"[\"empty_dir\",\"host_path\",\"persistent_volume\"]","x-ves-proto-message":"ves.io.schema.views.workload.StorageVolumeType","properties":{"empty_dir":{"$ref":"#/components/schemas/workloadEmptyDirectoryVolumeType"},"host_path":{"$ref":"#/components/schemas/workloadHostPathVolumeType"},"name":{"type":"string","description":" Name of the volume\n\nExample: ` \"volume-0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.dns_1123_label: true\n","title":"Name","x-displayname":"Name","x-ves-example":"volume-0","x-ves-validation-rules":{"ves.io.schema.rules.string.dns_1123_label":"true"}},"persistent_volume":{"$ref":"#/components/schemas/workloadPersistentStorageVolumeType"}}},"workloadTCPHealthCheckType":{"type":"object","description":"TCPHealthCheckType describes a health check based on opening a TCP connection","title":"TCPHealthCheckType","x-displayname":"TCP Health Check","x-ves-proto-message":"ves.io.schema.views.workload.TCPHealthCheckType","properties":{"port":{"$ref":"#/components/schemas/workloadPortChoiceType"}}},"workloadTCPLoadBalancerType":{"type":"object","description":"TCP loadbalancer","title":"TCPLoadBalancerType","x-displayname":"TCP Load Balancer","x-ves-proto-message":"ves.io.schema.views.workload.TCPLoadBalancerType","properties":{"domains":{"type":"array","description":" A list of additional domains (host/authority header) that will be matched to this loadbalancer.\n\n Domains are also used for SNI matching if the `with_sni` is true\n Domains also indicate the list of names for which DNS resolution will be done by VER\n\nExample: ` \"www.foo.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.hostname: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domains","maxItems":32,"items":{"type":"string"},"x-displayname":"Domains","x-ves-example":"www.foo.com","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.hostname":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}},"with_sni":{"type":"boolean","description":" Set to true to enable TCP loadbalancer with SNI\n\nExample: ` \"true\"`","title":"With SNI","format":"boolean","x-displayname":"With SNI","x-ves-example":"true"}}},"workloadUsageData":{"type":"object","description":"Usage data contains the usage type and the corresponding metric","title":"Usage Data","x-displayname":"Usage Data","x-ves-proto-message":"ves.io.schema.views.workload.UsageData","properties":{"data":{"type":"array","description":" List of metric data ","title":"Data","items":{"$ref":"#/components/schemas/workloadUsageTypeData"},"x-displayname":"Data"},"type":{"$ref":"#/components/schemas/workloadUsageType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"}}},"workloadUsageLabel":{"type":"string","description":"Labels in usage metric\n","title":"Usage Label","enum":["NAMESPACE","CONTAINER","POD","SITE","WORKLOAD"],"default":"NAMESPACE","x-displayname":"Usage Label","x-ves-proto-enum":"ves.io.schema.views.workload.UsageLabel"},"workloadUsageRequest":{"type":"object","description":"Request to get workload usage in the given namespace","title":"Usage Request","x-displayname":"Usage Request","x-ves-proto-message":"ves.io.schema.views.workload.UsageRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"type":"array","description":" Select fields to be returned in the response.\n One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Selector","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/workloadUsageType"},"x-displayname":"Field Selector","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"filter":{"type":"string","description":" filter is used to specify the list of matchers\n syntax for filter := {[<matcher>]}\n <matcher> := <label><operator>\"<value>\"\n   <label> := string\n     One or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter.\n   <value> := string\n   <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n     =  : equal to\n     != : not equal to\n     =~ : regex match\n     !~ : not regex match\n\n Optional: If not specified, all workloads usage in the given namespace will be aggregated based on the group_by field. \n\nExample: ` \"{POD=\\\"pod-1\\\"}\"`","title":"Label Filter","x-displayname":"Filter","x-ves-example":"{POD=\\\"pod-1\\\"}"},"group_by":{"type":"array","description":" Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}","title":"Group by","items":{"$ref":"#/components/schemas/workloadUsageLabel"},"x-displayname":"Group By"},"include_system_workloads":{"type":"boolean","description":" allows user to specify if the usage of system workloads (such as pods running in volterra namespaces and the kubernetes pods) should be included in the response.\n This field is applicable only in the `system` namespace where the response contains data across all namespaces.\n\n Optional: If not specified, only the workloads running in the customer namespaces would be returned in the response.","title":"Include System Workloads","format":"boolean","x-displayname":"Include System Workloads"},"namespace":{"type":"string","description":" namespace is used to scope the workload usage to a given namespace.\n\nExample: ` \"ns1\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":"\n start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"workloadUsageResponse":{"type":"object","description":"Workload usage response","title":"Usage Response","x-displayname":"Usage Response","x-ves-proto-message":"ves.io.schema.views.workload.UsageResponse","properties":{"data":{"type":"array","description":" Data contains time-series data for the workload usage","title":"Data","items":{"$ref":"#/components/schemas/workloadUsageData"},"x-displayname":"Data"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"workloadUsageType":{"type":"string","description":"List of usage types that can be queried\n\nx-unit: \"Number of cores\"\nx-unit: \"Bytes\"\nx-unit: \"Bytes per second\"\nx-unit: \"Bytes per second\"","title":"Usage Type","enum":["CPU_USAGE","MEMORY_USAGE","DISK_READS","DISK_WRITES"],"default":"CPU_USAGE","x-displayname":"Usage Type","x-ves-proto-enum":"ves.io.schema.views.workload.UsageType"},"workloadUsageTypeData":{"type":"object","description":"Usage Type Data contains key/value pair that uniquely identifies a workload in the response and the corresponding metric data.","title":"Usage Type Data","x-displayname":"Usage Type Data","x-ves-proto-message":"ves.io.schema.views.workload.UsageTypeData","properties":{"key":{"type":"object","description":" Key contains the name/value pair.\n \"name\" is the label name defined in \"UsageLabel\"","title":"Key","x-displayname":"Key"},"value":{"type":"array","description":" List of metric values.","title":"Value","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Value"}}},"workloadVolumeMountModeType":{"type":"string","description":"Mode in which the volume should be mounted to the workload\n\n - VOLUME_MOUNT_READ_ONLY: ReadOnly\n\nMount the volume in read-only mode\n - VOLUME_MOUNT_READ_WRITE: Read Write\n\nMount the volume in read-write mode","title":"VolumeMountModeType","enum":["VOLUME_MOUNT_READ_ONLY","VOLUME_MOUNT_READ_WRITE"],"default":"VOLUME_MOUNT_READ_ONLY","x-displayname":"Mode","x-ves-proto-enum":"ves.io.schema.views.workload.VolumeMountModeType"},"workloadVolumeMountType":{"type":"object","description":"Volume mount describes how volume is mounted inside a workload","title":"VolumeMountType","x-displayname":"Volume Mount","x-ves-proto-message":"ves.io.schema.views.workload.VolumeMountType","properties":{"mode":{"$ref":"#/components/schemas/workloadVolumeMountModeType"},"mount_path":{"type":"string","description":" Path within the workload container at which the volume should be mounted. Must not contain ':'.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.pattern: ^[^:]*$\n","title":"MountPath","maxLength":256,"x-displayname":"Mount Path","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.pattern":"^[^:]*$"}},"sub_path":{"type":"string","description":" Path within the volume from which the workload's volume should be mounted. Defaults to \"\" (volume's root).\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"SubPath","maxLength":256,"x-displayname":"Sub Path","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}}}}}}}