API reference

Packages

instana.io/v1beta1

Package v1beta1 contains API Schema definitions for the v1beta1 API group

Resource Types

ComponentConfig

ComponentConfig allows additional configuration for a specific component.

Appears in:

Field Description
name string
imageTag string Overrides the Docker image tag for the component.
replicas integer Number of desired replicas. Defaults to 1 if not set.
env EnvVar array List of additional environment variables to set in the container.
resources ResourceRequirements Compute resources required by this component. If omitted, the operator applies reasonable defaults, depending on the configured profile.
affinity Affinity Affinity is a group of affinity scheduling rules.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for the pod to be scheduled on that node.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches the triple key,value,effect by using the matching operator operator.
priorityClassName string Configures a priority class for the component.
properties Property array Configures component configuration properties.

Core

Core is the Schema for the cores API.

Appears in:

Field Description
apiVersion string instana.io/v1beta1
kind string Core
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec CoreSpec CoreSpec specifies the configuration of an Instana core.

CoreList

CoreList contains a list of Core.

Field Description
apiVersion string instana.io/v1beta1
kind string CoreList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Core  

CoreSpec

CoreSpec defines the desired state of Core.

Appears in:

Field Description
imageConfig ImageConfig Overrides the Docker image for the component. Only the fields that should be overridden (e.g. Tag) have to be set.
imagePullPolicy PullPolicy Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
serviceAccountAnnotations object (keys:string, values:string) Annotations for the ServiceAccount that is created for the pods. Can e.g. be used to assign IAM roles on EKS.
priorityClassName string Configures a global priority class for all pods created by the operator.
baseDomain string Base domain for Instana.
enableNetworkPolicies boolean If true, network policies are installed.
resourceProfile ResourceProfile The resource profile to use.
rawSpansStorageConfig RawSpansStorageConfig Configuration for raw spans storage. Configures where raw spans should be stored. Either a PersistentVolumeClaim or an object storage (S3 or compatible) bucket must be configured.
datastoreConfigs DatastoreConfig array DatastoreConfigs configure datastore connection information.
componentConfigs ComponentConfig array ComponentConfigs override component default configurations.
emailConfig EmailConfig Configuration for sending e-mails via Amazon SES or an SMTP server.
serviceProviderConfig ServiceProviderConfig Service provider configuration for SAML or OIDC.
proxyConfig HostPort ProxyConfig configuration.
geoDbUrl string URL for downloading the GeoLite2 geo-location data file.
agentAcceptorConfig HostPort Host and port for the agent acceptor.
featureFlags FeatureFlag array Configures globals feature flags.
properties Property array Configures global component configuration properties.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for pods to be scheduled on that node.
tolerations Toleration The pod that this toleration is attached to tolerates any taint that matches the triple key,value,effect by using the matching operator operator.

DatastoreConfig

Appears in:

Field Description
type DatastoreType The datastore type.
addresses string array A list of hosts for connecting to the datastore. For ClickHouse clusters, entries must be in correct order for sharding.
ports NamedPort array A list of named ports for connection to the datastore. If omitted, default ports are used.
schemas string array A list of schemas for the datastore.
clusterName string A cluster name is required for ClickHouse (default: 'local') and Elasticsearch (default: 'onprem_onprem'). If not specified, defaults apply.
properties Property array Optional properties that may be used for the DB setup.

DatastoreType

Underlying type: string

Appears in:

EmailConfig

EmailConfig is configuration for email.

Appears in:

Field Description
smtpConfig SMTPConfig Configures an SMTP server for sending e-mails.
sesConfig SESConfig Configures Amazon Simple Email Service for sending e-mails.

FeatureFlag

FeatureFlag flag configuration.

Appears in:

Field Description
name string The name of the feature flag.
enabled boolean Toggles the feature flag.

HostPort

HostPort holds a host and port combination.

Appears in:

Field Description
host string The host name or IP address.
port integer The port.

ImageConfig

ImageConfig configures the Docker image for the components.

Appears in:

Field Description
registry string The Docker registry to use. Defaults to 'containers.instana.io'.
repository string Path to the image within the registry. Defaults to 'instana/release/product'. The operator automatically appends component names when it computes the full image tag.
tag string The image version to use. Each operator release comes with a default version that is used when the field is left empty.

NamedPort

NamedPort holds a port with a name.

Appears in:

Field Description
name string The n ame of the port
port integer The port.

ObjectStorageConfig

ObjectStorageConfig configuration.

Appears in:

Field Description
endpoint string Endpoint address of the object storage.
region string Region.
bucket string Bucket name.
prefix string Prefix for the storage bucket.
storageClass string Storage class.
bucketLongTerm string Bucket name for long-term storage.
prefixLongTerm string Prefix for the long-term storage bucket.
storageClassLongTerm string Storage class for objects written to the long-term bucket.

Property

Property for component configuration.

Appears in:

Field Description
name string The name of the property.
value string The value of the property.

RawSpansStorageConfig

RawSpansStorageConfig storage configuration. Configures where raw spans should be stored. Either a PersistentVolumeClaim or an object storage (S3 or compatible) bucket must be configured.

Appears in:

Field Description
pvcConfig PersistentVolumeClaimSpec Configures a PersistentVolumeClaim for raw spans storage. The volume must support ReadWriteMany access.
objectStorageConfig ObjectStorageConfig Configures an object storage (S3 or compatible) for raw spans storage.

ResourceProfile

Underlying type: string

ResourceProfile denotes the type for holding the profile name.

Appears in:

SESConfig

SESConfig configures Amazon Simple Email Service for sending e-mails.

Appears in:

Field Description
from string From e-mail address.
returnPath string Return path.
region string AWS region.

SMTPConfig

SMTPConfig configures an SMTP server for sending e-mails.

Appears in:

Field Description
from string From e-mail address.
host string Host name of the SMTP server.
port integer Port of the SMTP server.
useSSL boolean UseSSL enables SSL if set to true.
startTLS boolean StartTLS enables StartTLS if set to true.
check_server_identity boolean CheckServerIdentity enables server identity verification if set to true.

ServiceProviderConfig

Appears in:

Field Description
basePath string Base URL (defaults to "/auth").
maxIDPMetadataSizeInBytes integer The maximum IDP metadata size (defaults to 200000).
maxAuthenticationLifetimeSeconds integer The maximum authentication lifetime (defaults to 604800).

Unit

Unit is the Schema for the units API

Appears in:

Field Description
apiVersion string instana.io/v1beta1
kind string Unit
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec UnitSpec

UnitList

UnitList contains a list of Unit

Field Description
apiVersion string instana.io/v1beta1
kind string UnitList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Unit  

UnitSpec

UnitSpec defines the desired state of Unit

Appears in:

Field Description
coreName string Name of the core
coreNamespace string Namespace where the core components reside
unitName string Name of the tenant unit
tenantName string Name of the tenant
resourceProfile ResourceProfile The resource profile to use.
initialAgentKey string The agent key that is used for the initial unit setup
componentConfigs ComponentConfig array ComponentConfigs overrides component default configurations.
priorityClassName string Configures a priority class for all unit components. Overrides a priority class configured on core level.
properties Property array Configures component configuration properties.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for pods to be scheduled on that node. Overrides a node selector configured on core level.
tolerations Toleration The pod that this toleration is attached to tolerates any taint that matches the triple key,value,effect by using the matching operator operator. Overrides tolerations configured on core level.