API 參考資料

套件

instana.io/v1beta2

套件 v1beta2 包含 v1beta2 API 群組的「API 綱目」定義

資源類型

BeeInstana配置

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
clustered 布林

CassandraConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
keyspaces 字串陣列
replicationFactor 整數

ClickhouseConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
schemas 字串陣列
clusterName 字串

ComponentConfig

ComponentConfig 容許特定元件的其他配置。

出現在:

欄位 說明
name 字串 元件的名稱。
disabled 布林 停用元件。
imageTag 字串 置換元件的 Docker 映像檔標籤。
replicas 整數 想要的抄本數。 如果未設定，則預設為 1。
env Env 陣列 要在儲存器中設定的其他環境變數清單。
resources ResourceRequirements 此元件所需的計算資源。 如果省略的話，根據所配置的設定檔，運算子會套用合理的預設值。
affinity 親緣性 親緣性是一組親緣性排程規則。
nodeSelector 物件 (索引鍵: 字串，值: 字串) 必須符合節點標籤，才能在該節點上排定 Pod 的選取器。
tolerations 容錯 陣列 此容錯所連接的 Pod 會使用相符運算子 operator來容忍任何符合三項值 key,value,effect 的污染。
priorityClassName 字串 配置元件的優先順序類別。
properties 內容 陣列 配置元件配置內容。

核心

核心是核心 API 的綱目。

出現在:

欄位 說明
apiVersion 字串 instana.io/v1beta2
kind 字串 Core
metadata ObjectMeta 請參閱 Kubernetes API 文件，以取得 metadata的欄位。
spec CoreSpec CoreSpec 指定 Instana 核心的配置。

CoreList

CoreList 包含「核心」清單。

欄位 說明
apiVersion 字串 instana.io/v1beta2
kind 字串 CoreList
metadata ListMeta 請參閱 Kubernetes API 文件，以取得 metadata的欄位。
items Core 陣列

CoreSpec

CoreSpec 定義「核心」所需的狀態。

出現在:

欄位 說明
imageConfig ImageConfig 置換元件的 Docker 映像檔。 只需要設定應該置換的欄位 (例如標籤)。
imagePullPolicy PullPolicy 映像檔取回原則。 Always、Never、 IfNot之一存在。 預設值為 Always if: latest tag is specified ， or IfNotpresent otherwise.
imagePullSecrets LocalObject參照 陣列 ImagePull「密鑰」是用於取回映像檔之密鑰的選用參照清單。 指定的密鑰必須存在於核心及單元名稱空間中。
serviceAccountAnnotations 物件 (索引鍵: 字串，值: 字串) 為 Pod 建立之 ServiceAccount 的註釋。 例如，可用來在 EKS 上指派 IAM 角色。
priorityClassName 字串 為操作器所建立的所有 Pod 配置廣域優先順序類別。
baseDomain 字串 Instana 的基本網域。
resourceProfile ResourceProfile 要使用的資源設定檔。
storageConfigs StorageConfigs 所有外部儲存體的配置。 配置應該儲存每一個元件的外部儲存體的位置。
heapDumpsPVC PersistentVolumeClaimSpec 配置 PVC 以儲存 JVM 資料堆傾出。 如果未配置，資料堆傾出會寫入 OufOfMemoryError上已裝載的 emptyDir 。 磁區必須支援 ReadWrite許多存取權。
datastoreConfigs DatastoreConfigs DatastoreConfigs 配置資料儲存庫連線資訊。
componentConfigs ComponentConfig 陣列 ComponentConfigs 會置換元件預設配置。
deploymentStrategyType DeploymentStrategy類型 元件部署的部署策略類型 (預設值: RollingUpdate)
emailConfig EmailConfig 透過 Amazon SES 或 SMTP 伺服器傳送電子郵件的配置。
serviceProviderConfig ServiceProvider配置 SAML 或 OIDC 的服務提供者配置。
proxyConfig ProxyConfig ProxyConfig 配置。
geoDbUrl 字串 用於下載 GeoLite2 地理定位資料檔的 URL。
agentAcceptorConfig HostPort 代理程式接收器的主機及埠。
featureFlags FeatureFlag 陣列 配置廣域特性旗標。
env Env 陣列 配置廣域環境變數。
properties 內容 陣列 配置廣域元件配置內容。
nodeSelector 物件 (索引鍵: 字串，值: 字串) 必須符合節點標籤，才能在該節點上排定 Pod 的選取器。
tolerations 容錯 陣列 此容錯所連接的 Pod 會使用相符運算子 operator來容忍任何符合三項值 key,value,effect 的污染。
operationMode OperationMode 操作員作業模式。 'normal' 或 'maintenance' 其中之一 (預設為 'normal')。 如果部署設為「維護」，則會調整為零。
operationScopes OperationScope 陣列 定義要部署之範圍的元件。 僅與 SaaS類似部署實務相關。

DatastoreConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。

DatastoreConfigs

出現在:

欄位 說明
cassandraConfigs CassandraConfig 陣列
clickhouseConfigs ClickhouseConfig 陣列
elasticsearchConfig ElasticsearchConfig
kafkaConfig KafkaConfig
beeInstanaConfig BeeInstana配置
postgresConfigs PostgresConfig 陣列

ElasticsearchConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
clusterName 字串
defaultIndexShards 整數
defaultIndexReplicas 整數
defaultIndexRoutingPartitionSize 整數
indexConfigs IndexConfig 陣列

EmailConfig

EmailConfig 是電子郵件的配置。

出現在:

欄位 說明
smtpConfig SMTPConfig 配置 SMTP 伺服器以傳送電子郵件。
sesConfig SESConfig 配置 Amazon Simple Email Service 以傳送電子郵件。

Env

環境變數配置。

出現在:

欄位 說明
name 字串 環境變數的名稱。
value 字串 環境變數的值。

FeatureFlag

FeatureFlag 旗標配置。

出現在:

欄位 說明
name 字串 特性旗標的名稱。
enabled 布林 切換特性旗標。

GCloudConfig

GCloudConfig 配置。

出現在:

欄位 說明
bucket 字串 儲存區名稱。
prefix 字串 儲存體儲存區的字首。
storageClass 字串 儲存類別。
bucketLongTerm 字串 長期儲存體的儲存區名稱。
prefixLongTerm 字串 長期儲存體儲存區的字首。
storageClassLongTerm 字串 寫入長期儲存區之物件的儲存類別。

HostPort

HostPort 會保留主機與埠的組合。

出現在:

欄位 說明
host 字串 主機名稱或 IP 位址。
port 整數 埠。

ImageConfig

ImageConfig 會配置元件的 Docker 映像檔。

出現在:

欄位 說明
registry 字串 要使用的 Docker 登錄。 預設值為 'artifact-public.instana.io'。
repository 字串 登錄內映像檔的路徑。 預設為 'backend'。 運算子會在計算完整影像標籤時自動附加元件名稱。
tag 字串 要使用的映像檔版本。 每一個操作員版本都隨附一個預設版本，當該欄位保留空白時即會使用該預設版本。

IndexConfig

出現在:

欄位 說明
name 字串
shards 整數
replicas 整數
routingPartitionSize 整數

KafkaConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
replicationFactor 整數
saslMechanism 字串 用戶端用來向分配管理系統進行鑑別的 SASL 機制。 可能的值為 PLAIN、 SCRAM-SHA-256、 SCRAM-SHA-512。

NamedPort

NamedPort 會保留名稱為的埠。

出現在:

OperationMode

基礎類型: string

出現在:

OperationScope

基礎類型: string

出現在:

PostgresConfig

出現在:

欄位 說明
hosts 字串陣列 用於連接至資料儲存庫的主機清單。 對於 ClickHouse 叢集，項目必須以正確的順序進行分區。
ports NamedPort 陣列 資料儲存庫連線的具名埠清單。 如果省略，則會使用預設埠。
properties 內容 陣列 可用於資料庫設定的選用內容。
authEnabled 布林 啟用資料儲存庫的鑑別。 預期在核心名稱空間中與對應核心具有相同名稱的密鑰中配置認證。
databases 字串陣列

內容

元件配置的內容。

出現在:

ProxyConfig

出現在:

欄位 說明
host 字串 主機名稱或 IP 位址。
port 整數 埠。

ResourceProfile

基礎類型: string

ResourceProfile 表示保留設定檔名稱的類型。

出現在:

S3Config

S3Config 配置。

出現在:

欄位 說明
endpoint 字串 物件儲存體的端點位址。
region 字串 區域。
bucket 字串 儲存區名稱。
prefix 字串 儲存體儲存區的字首。
storageClass 字串 儲存類別。
bucketLongTerm 字串 長期儲存體的儲存區名稱。
prefixLongTerm 字串 長期儲存體儲存區的字首。
storageClassLongTerm 字串 寫入長期儲存區之物件的儲存類別。

SESConfig

SESConfig 會配置 Amazon Simple Email Service ，以傳送電子郵件。

出現在:

欄位 說明
from 字串 從電子郵件位址。
returnPath 字串 傳回路徑。
region 字串 AWS 區域。

SMTPConfig

SMTPConfig 會配置 SMTP 伺服器以傳送電子郵件。

出現在:

欄位 說明
from 字串 從電子郵件位址。
host 字串 SMTP 伺服器的主機名稱。
port 整數 SMTP 伺服器的埠。
useSSL 布林 如果設為 true ， UseSSL 會啟用 SSL。
startTLS 布林 如果設為 true ， StartTLS 會啟用 StartTLS 。
check_server_identity 布林 CheckServer如果設為 true ，身分會啟用伺服器身分驗證。

ServiceProvider配置

出現在:

欄位 說明
basePath 字串 基本 URL (預設為 "/auth")。
maxIDPMetadataSizeInBytes 整數 IDP meta 資料大小上限 (預設為 200000)。
maxAuthenticationLifetimeSeconds 整數 鑑別生命期限上限 (預設為 604800)。

狀態

基礎類型: string

Instana 狀態。

出現在:

StorageConfig

出現在:

欄位 說明
pvcConfig PersistentVolumeClaimSpec 配置外部儲存體的 PersistentVolume要求。 磁區必須支援 ReadWrite許多存取權。
s3Config S3Config 配置外部儲存體的 S3 (或相容)。
gcloudConfig GCloudConfig 配置外部儲存體的 Google Cloud Storage 。

StorageConfigs

外部儲存體 (PVC、 S3、GCloud 儲存區) 的配置

出現在:

欄位 說明
rawSpans StorageConfig 原始跨距外部儲存體的配置。 配置應該儲存原始文字段的位置。
synthetics StorageConfig 綜合外部儲存體的配置。 配置應該儲存綜合測試結果的位置。
syntheticsKeystore StorageConfig Syntheics 外部儲存體的配置。 配置 Synthetics 儲存認證的位置。
eumSourceMaps StorageConfig EUM 外部儲存體的配置。 配置應儲存 EUM 來源對映的位置。

單元

單元是單元 API 的綱目。

出現在:

欄位 說明
apiVersion 字串 instana.io/v1beta2
kind 字串 Unit
metadata ObjectMeta 請參閱 Kubernetes API 文件，以取得 metadata的欄位。
spec UnitSpec

UnitList

UnitList 包含單元清單。

欄位 說明
apiVersion 字串 instana.io/v1beta2
kind 字串 UnitList
metadata ListMeta 請參閱 Kubernetes API 文件，以取得 metadata的欄位。
items Unit 陣列

UnitSpec

UnitSpec 定義想要的單元狀態

出現在:

欄位 說明
coreName 字串 核心的名稱。
coreNamespace 字串 核心元件所在的名稱空間。
unitName 字串 租戶單位的名稱。
tenantName 字串 租戶的名稱。
resourceProfile ResourceProfile 要使用的資源設定檔。
heapDumpsPVC PersistentVolumeClaimSpec 配置 PVC 以儲存 JVM 資料堆傾出。 如果未配置，資料堆傾出會寫入 OufOfMemoryError上已裝載的 emptyDir 。 磁區必須支援 ReadWrite許多存取權。
env Env 陣列 配置廣域環境變數。
componentConfigs ComponentConfig 陣列 ComponentConfigs 會置換元件預設配置。
priorityClassName 字串 配置所有單元元件的優先順序類別。 置換核心層次上配置的優先順序類別。
properties 內容 陣列 配置元件配置內容。
nodeSelector 物件 (索引鍵: 字串，值: 字串) 必須符合節點標籤，才能在該節點上排定 Pod 的選取器。 置換在核心層次上配置的節點選取器。
tolerations 容錯 陣列 此容錯所連接的 Pod 會使用相符運算子 operator來容忍任何符合三項值 key,value,effect 的污染。 置換核心層次上配置的容錯。
operationMode OperationMode 裝置作業模式。 'normal' 或 'maintenance' 其中之一 (預設為 'normal')。 如果部署設為「維護」，則會調整為零。