maistra.io/api/core/v2
AddonsConfig configures additional features for use with the mesh
| Name | Description | Type |
|---|---|---|
3scale |
ThreeScale configures the 3scale adapter |
|
grafana |
Grafana configures a grafana instance to use with the mesh .Values.grafana.enabled, true if not null |
|
jaeger |
Jaeger configures Jaeger specific addon capabilities |
|
kiali |
Kiali configures a kiali instance to use with the mesh .Values.kiali.enabled, true if not null |
|
prometheus |
Prometheus configures Prometheus specific addon capabilities |
|
stackdriver |
Stackdriver configures Stackdriver specific addon capabilities |
maistra.io/api/core/v2
ThreeScaleAddonConfig represents configuration options for the installation of the 3scale adapter. The options are structured similarly to what is defined by the 3scale ConfigMap.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
backend |
Backend configures backend specific details |
|
client |
Client configures client specific details |
|
grpc |
GRPC configures gRPC specific details |
|
listen_addr |
ListenerAddr sets the listen address for the gRPC server. PARAM_THREESCALE_LISTEN_ADDR |
integer |
log_grpc |
LogGRPC controls whether the log includes gRPC info PARAM_THREESCALE_LOG_GRPC |
boolean |
log_json |
LogJSON controls whether the log is formatted as JSON PARAM_THREESCALE_LOG_JSON |
boolean |
log_level |
LogLevel sets the minimum log output level. Accepted values are one of: debug, info, warn, error, none PARAM_THREESCALE_LOG_LEVEL |
string |
metrics |
Metrics configures metrics specific details |
|
system |
System configures system specific details |
maistra.io/api/core/v2
ThreeScaleBackendConfig represents 3scale adapter options for its 'backend' section.
| Name | Description | Type |
|---|---|---|
cache_flush_interval |
CacheFlushInterval sets the interval at which metrics get reported from the cache to 3scale PARAM_THREESCALE_BACKEND_CACHE_FLUSH_INTERVAL_SECONDS |
integer |
enable_cache |
EnableCache if true, attempts to create an in-memory apisonator cache for authorization requests PARAM_THREESCALE_USE_CACHED_BACKEND |
boolean |
policy_fail_closed |
PolicyFailClosed if true, request will fail if 3scale Apisonator is unreachable PARAM_THREESCALE_BACKEND_CACHE_POLICY_FAIL_CLOSED |
boolean |
maistra.io/api/core/v2
ThreeScaleClientConfig represents 3scale adapter options for its 'client' section.
| Name | Description | Type |
|---|---|---|
allow_insecure_connections |
AllowInsecureConnections skips certificate verification when calling 3scale API’s. Enabling is not recommended PARAM_THREESCALE_ALLOW_INSECURE_CONN |
boolean |
timeout |
Timeout sets the number of seconds to wait before terminating requests to 3scale System and Backend PARAM_THREESCALE_CLIENT_TIMEOUT_SECONDS |
integer |
maistra.io/api/core/v2
ThreeScaleGRPCConfig represents 3scale adapter options for its 'grpc' section.
| Name | Description | Type |
|---|---|---|
max_conn_timeout |
MaxConnTimeout sets the maximum amount of seconds (+/-10% jitter) a connection may exist before it will be closed PARAM_THREESCALE_GRPC_CONN_MAX_SECONDS |
integer |
maistra.io/api/core/v2
ThreeScaleMetricsConfig represents 3scale adapter options for its 'metrics' section.
| Name | Description | Type |
|---|---|---|
port |
Port sets the port which 3scale /metrics endpoint can be scrapped from PARAM_THREESCALE_METRICS_PORT |
integer |
report |
Report controls whether 3scale system and backend metrics are collected and reported to Prometheus PARAM_THREESCALE_REPORT_METRICS |
boolean |
maistra.io/api/core/v2
ThreeScaleSystemConfig represents 3scale adapter options for its 'system' section.
| Name | Description | Type |
|---|---|---|
cache_max_size |
CacheMaxSize is the max number of items that can be stored in the cache at any time. Set to 0 to disable caching PARAM_THREESCALE_CACHE_ENTRIES_MAX |
integer |
cache_refresh_interval |
CacheRefreshInterval is the time period in seconds, before a background process attempts to refresh cached entries PARAM_THREESCALE_CACHE_REFRESH_SECONDS |
integer |
cache_refresh_retries |
CacheRefreshRetries sets the number of times unreachable hosts will be retried during a cache update loop PARAM_THREESCALE_CACHE_REFRESH_RETRIES |
integer |
cache_ttl |
CacheTTL is the time period, in seconds, to wait before purging expired items from the cache PARAM_THREESCALE_CACHE_TTL_SECONDS |
integer |
maistra.io/api/core/v2
GrafanaAddonConfig configures a grafana instance for use with the mesh. Only one of install or address may be specified
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
address |
Address is the address of an existing grafana installation implies .Values.kiali.dashboard.grafanaURL |
string |
install |
Install a new grafana instance and manage with control plane |
maistra.io/api/core/v2
GrafanaInstallConfig is used to configure a new installation of grafana.
| Name | Description | Type |
|---|---|---|
config |
Config configures the behavior of the grafana installation |
|
persistence |
Persistence configures a PersistentVolume associated with the grafana installation .Values.grafana.persist, true if not null XXX: capacity is not supported in the charts, hard coded to 5Gi |
|
security |
Security is used to secure the grafana service. .Values.grafana.security.enabled, true if not null XXX: unused for maistra, as we use oauth-proxy |
|
selfManaged |
SelfManaged, true if the entire install should be managed by Maistra, false if using grafana CR (not supported) |
boolean |
service |
Service configures the k8s Service associated with the grafana installation XXX: grafana service config does not follow other addon components' structure |
maistra.io/api/core/v2
GrafanaConfig configures the behavior of the grafana installation
| Name | Description | Type |
|---|---|---|
env |
Env allows specification of various grafana environment variables to be configured on the grafana container. .Values.grafana.env XXX: This is pretty cheesy… |
map[string]string |
envSecrets |
EnvSecrets allows specification of secret fields into grafana environment variables to be configured on the grafana container .Values.grafana.envSecrets XXX: This is pretty cheesy… |
map[string]string |
maistra.io/api/core/v2
ComponentPersistenceConfig is used to configure persistance for a component.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
accessMode |
AccessMode for the PersistentVolumeClaim |
|
capacity |
Resources to request for the PersistentVolumeClaim |
|
storageClassName |
StorageClassName for the PersistentVolumeClaim |
string |
maistra.io/api/core/v2
GrafanaSecurityConfig is used to secure access to grafana
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
passphraseKey |
PassphraseKey is the name of the key within the secret identifying the password. |
string |
secretName |
SecretName is the name of a secret containing the username/password that should be used to access grafana. |
string |
usernameKey |
UsernameKey is the name of the key within the secret identifying the username. |
string |
maistra.io/api/core/v2
ComponentServiceConfig is used to customize the service associated with a component.
| Name | Description | Type |
|---|---|---|
ingress |
Ingress specifies details for accessing the component’s service through a k8s Ingress or OpenShift Route. |
|
metadata |
Metadata represents addtional annotations/labels to be applied to the component’s service. |
|
nodePort |
NodePort specifies a NodePort for the component’s Service. .Values.<component>.service.nodePort.port, …enabled is true if not null |
integer |
maistra.io/api/core/v2
ComponentIngressConfig is used to customize a k8s Ingress or OpenShift Route for the service associated with a component.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
contextPath |
ContextPath represents the context path to the service. |
string |
hosts |
Hosts represents a list of host names to configure. Note, OpenShift route only supports a single host name per route. An empty host name implies a default host name for the Route. XXX: is a host name required for k8s Ingress? |
[]string |
metadata |
Metadata represents additional metadata to be applied to the ingress/route. |
|
tls |
TLS is used to configure TLS for the Ingress/Route XXX: should this be something like RawExtension, as the configuration differs between Route and Ingress? |
maistra.io/api/core/v2
MetadataConfig represents additional metadata to be applied to resources
| Name | Description | Type |
|---|---|---|
annotations |
map[string]string |
|
labels |
map[string]string |
maistra.io/api/core/v2
JaegerAddonConfig configuration specific to Jaeger integration. XXX: this currently deviates from upstream, which creates a jaeger all-in-one deployment manually
| Name | Description | Type |
|---|---|---|
install |
Install configures a Jaeger installation, which will be created if the named Jaeger resource is not present. If null, the named Jaeger resource must exist. |
|
name |
Name of Jaeger CR, Namespace must match control plane namespace |
string |
maistra.io/api/core/v2
JaegerInstallConfig configures a Jaeger installation.
| Name | Description | Type |
|---|---|---|
ingress |
Ingress configures k8s Ingress or OpenShift Route for Jaeger services .Values.tracing.jaeger.ingress.enabled, false if null |
|
storage |
Config represents the configuration of Jaeger behavior. |
maistra.io/api/core/v2
JaegerIngressConfig configures k8s Ingress or OpenShift Route for exposing Jaeger services.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
metadata |
Metadata represents addtional annotations/labels to be applied to the ingress/route. |
maistra.io/api/core/v2
JaegerStorageConfig configures the storage used by the Jaeger installation.
| Name | Description | Type |
|---|---|---|
elasticsearch |
Elasticsearch represents configuration of elasticsearch storage implies .Values.tracing.jaeger.template=production-elasticsearch |
|
memory |
Memory represents configuration of in-memory storage implies .Values.tracing.jaeger.template=all-in-one |
|
type |
Type of storage to use |
maistra.io/api/core/v2
JaegerElasticsearchStorageConfig configures elasticsearch storage parameters for Jaeger
| Name | Description | Type |
|---|---|---|
indexCleaner |
IndexCleaner represents the configuration for the elasticsearch index cleaner .Values.tracing.jaeger.elasticsearch.esIndexCleaner, raw yaml XXX: RawExtension? |
|
nodeCount |
NodeCount represents the number of elasticsearch nodes to create. .Values.tracing.jaeger.elasticsearch.nodeCount, defaults to 3 |
integer |
redundancyPolicy |
RedundancyPolicy configures the redundancy policy for elasticsearch .Values.tracing.jaeger.elasticsearch.redundancyPolicy, raw yaml |
string |
storage |
Storage represents storage configuration for elasticsearch. .Values.tracing.jaeger.elasticsearch.storage, raw yaml XXX: RawExtension? |
maistra.io/api/core/v2
JaegerMemoryStorageConfig configures in-memory storage parameters for Jaeger
| Name | Description | Type |
|---|---|---|
maxTraces |
MaxTraces to store .Values.tracing.jaeger.memory.max_traces, defaults to 100000 |
integer |
maistra.io/api/core/v2
JaegerStorageType represents the type of storage configured for Jaeger
Type: string
maistra.io/api/core/v2
KialiAddonConfig is used to configure a kiali instance for use with the mesh
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
install |
Install a Kiali resource if the named Kiali resource is not present. |
|
name |
Name of Kiali CR, Namespace must match control plane namespace |
string |
maistra.io/api/core/v2
KialiInstallConfig is used to configure a kiali installation
| Name | Description | Type |
|---|---|---|
dashboard |
Dashboard configures the behavior of the kiali dashboard. |
|
service |
Service is used to configure the k8s Service associated with the kiali installation. XXX: provided for upstream support, only ingress is used, and then only for enablement and contextPath |
maistra.io/api/core/v2
KialiDashboardConfig configures the behavior of the kiali dashboard
| Name | Description | Type |
|---|---|---|
enableGrafana |
XXX: should the user have a choice here, or should these be configured automatically if they are enabled for the control plane installation? Grafana endpoint will be configured based on Grafana configuration |
boolean |
enablePrometheus |
Prometheus endpoint will be configured based on Prometheus configuration |
boolean |
enableTracing |
Tracing endpoint will be configured based on Tracing configuration |
boolean |
viewOnly |
ViewOnly configures view_only_mode for the dashboard .Values.kiali.dashboard.viewOnlyMode |
boolean |
maistra.io/api/core/v2
PrometheusAddonConfig configures a prometheus instance to be used by the control plane. Only one of Install or Address may be specified
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
address |
Address of existing prometheus installation implies .Values.kiali.prometheusAddr XXX: do we need to do anything to configure credentials for accessing the prometheus server? |
string |
install |
Install configuration if not using an existing prometheus installation. .Values.prometheus.enabled, if not null |
|
metricsExpiryDuration |
MetricsExpiryDuration is the duration to hold metrics. (mixer/v1 only) .Values.mixer.adapters.prometheus.metricsExpiryDuration, defaults to 10m |
string |
scrape |
Scrape metrics from the pod if true. (maistra-2.0+) defaults to true .Values.meshConfig.enablePrometheusMerge |
boolean |
maistra.io/api/core/v2
PrometheusInstallConfig represents the configuration to be applied when installing a new instance of prometheus for use with the mesh.
| Name | Description | Type |
|---|---|---|
retention |
Retention specifies how long metrics should be retained by prometheus. .Values.prometheus.retention, defaults to 6h |
string |
scrapeInterval |
ScrapeInterval specifies how frequently prometheus should scrape pods for metrics. .Values.prometheus.scrapeInterval, defaults to 15s |
string |
selfManaged |
SelfManaged specifies whether or not the entire install should be managed by Maistra (true) or the Prometheus operator (false, not supported). Governs use of either prometheus charts or prometheusOperator charts. |
boolean |
service |
Service allows for customization of the k8s Service associated with the prometheus installation. |
|
useTLS |
UseTLS for the prometheus server .Values.prometheus.provisionPrometheusCert 1.6+ ProvisionCert bool this seems to overlap with provision cert, as this manifests something similar to the above .Values.prometheus.security.enabled, version < 1.6 EnableSecurity bool |
boolean |
maistra.io/api/core/v2
StackdriverAddonConfig configuration specific to Stackdriver integration.
| Name | Description | Type |
|---|---|---|
telemetry |
Configuration for Stackdriver telemetry plugins. Applies when telemetry is enabled |
|
tracer |
Configuration for Stackdriver tracer. Applies when Addons.Tracer.Type=Stackdriver |
maistra.io/api/core/v2
StackdriverTelemetryConfig adds telemetry filters for Stackdriver.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
accessLogging |
DisableOutbound disables intallation of sidecar outbound filter .Values.telemetry.v2.stackdriver.disableOutbound, defaults to false DisableOutbound bool |
|
auth |
Auth configuration for stackdriver adapter (mixer/v1 telemetry only) .Values.mixer.adapters.stackdriver.auth |
|
configOverride |
ConfigOverride apply custom configuration to Stackdriver filters (v2 telemetry only) .Values.telemetry.v2.stackdriver.configOverride |
|
enableContextGraph |
EnableContextGraph for stackdriver adapter (edge reporting) .Values.mixer.adapters.stackdriver.contextGraph.enabled, defaults to false .Values.telemetry.v2.stackdriver.topology, defaults to false |
boolean |
enableLogging |
EnableLogging for stackdriver adapter .Values.mixer.adapters.stackdriver.logging.enabled, defaults to true .Values.telemetry.v2.stackdriver.logging, defaults to false |
boolean |
enableMetrics |
EnableMetrics for stackdriver adapter .Values.mixer.adapters.stackdriver.metrics.enabled, defaults to true .Values.telemetry.v2.stackdriver.monitoring??? defaults to false |
boolean |
maistra.io/api/core/v2
StackdriverAccessLogTelemetryConfig for v2 telemetry.
| Name | Description | Type |
|---|---|---|
enabled |
Enabled specifies whether or not this feature is enabled |
boolean |
logWindowDuration |
LogWindowDuration configures the log window duration for access logs. defaults to 43200s To reduce the number of successful logs, default log window duration is set to 12 hours. .Values.telemetry.v2.accessLogPolicy.logWindowDuration |
string |
maistra.io/api/core/v2
StackdriverAuthConfig is the auth config for stackdriver. Only one field may be set
| Name | Description | Type |
|---|---|---|
apiKey |
APIKey use the specified key. .Values.mixer.adapters.stackdriver.auth.apiKey |
string |
appCredentials |
AppCredentials if true, use default app credentials. .Values.mixer.adapters.stackdriver.auth.appCredentials, defaults to false |
boolean |
serviceAccountPath |
ServiceAccountPath use the path to the service account. .Values.mixer.adapters.stackdriver.auth.serviceAccountPath |
string |
maistra.io/api/core/v2
StackdriverTracerConfig configures the Stackdriver tracer
| Name | Description | Type |
|---|---|---|
debug |
.Values.global.tracer.stackdriver.debug |
boolean |
maxNumberOfAnnotations |
.Values.global.tracer.stackdriver.maxNumberOfAnnotations |
integer |
maxNumberOfAttributes |
.Values.global.tracer.stackdriver.maxNumberOfAttributes |
integer |
maxNumberOfMessageEvents |
.Values.global.tracer.stackdriver.maxNumberOfMessageEvents |
integer |