agent.k8s.elastic.co/v1alpha1
ECK
Package v1alpha1 contains API Schema definitions for the agent v1alpha1 API group
Agent is the Schema for the Agents API.
| Field | Description |
|---|---|
apiVersion string |
agent.k8s.elastic.co/v1alpha1 |
kind string |
Agent |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec AgentSpec |
Appears In:
AgentSpec defines the desired state of the Agent
Appears In:
| Field | Description |
|---|---|
version string |
Version of the Agent. |
elasticsearchRefs Output array |
ElasticsearchRefs is a reference to a list of Elasticsearch clusters running in the same Kubernetes cluster. Due to existing limitations, only a single ES cluster is currently supported. |
image string |
Image is the Agent Docker image to deploy. Version has to match the Agent in the image. |
config Config |
Config holds the Agent configuration. At most one of [Config, ConfigRef] can be specified. |
configRef ConfigSource |
ConfigRef contains a reference to an existing Kubernetes Secret holding the Agent configuration. Agent settings must be specified as yaml, under a single "agent.yml" entry. At most one of [Config, ConfigRef] can be specified. |
secureSettings SecretSource array |
SecureSettings is a list of references to Kubernetes Secrets containing sensitive configuration options for the Agent. Secrets data can be then referenced in the Agent config using the Secret’s keys or as specified in Entries field of each SecureSetting. |
serviceAccountName string |
ServiceAccountName is used to check access from the current resource to an Elasticsearch resource in a different namespace. Can only be used if ECK is enforcing RBAC on references. |
daemonSet DaemonSetSpec |
DaemonSet specifies the Agent should be deployed as a DaemonSet, and allows providing its spec. Cannot be used along with deployment or statefulSet. |
deployment DeploymentSpec |
Deployment specifies the Agent should be deployed as a Deployment, and allows providing its spec. Cannot be used along with daemonSet or statefulSet. |
statefulSet StatefulSetSpec |
StatefulSet specifies the Agent should be deployed as a StatefulSet, and allows providing its spec. Cannot be used along with daemonSet or deployment. |
revisionHistoryLimit integer |
RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying DaemonSet or Deployment or StatefulSet. |
http HTTPConfig |
HTTP holds the HTTP layer configuration for the Agent in Fleet mode with Fleet Server enabled. |
mode AgentMode |
Mode specifies the source of configuration for the Agent. The configuration can be specified locally through config or configRef (standalone mode), or come from Fleet during runtime (fleet mode). Defaults to standalone mode. |
fleetServerEnabled boolean |
FleetServerEnabled determines whether this Agent will launch Fleet Server. Don’t set unless mode is set to fleet. |
policyID string |
PolicyID determines into which Agent Policy this Agent will be enrolled. This field will become mandatory in a future release, default policies are deprecated since 8.1.0. |
kibanaRef ObjectSelector |
KibanaRef is a reference to Kibana where Fleet should be set up and this Agent should be enrolled. Don’t set unless mode is set to fleet. |
fleetServerRef ObjectSelector |
FleetServerRef is a reference to Fleet Server that this Agent should connect to to obtain it’s configuration. Don’t set unless mode is set to fleet. |
Appears In:
| Field | Description |
|---|---|
podTemplate PodTemplateSpec |
|
updateStrategy DaemonSetUpdateStrategy |
Appears In:
| Field | Description |
|---|---|
podTemplate PodTemplateSpec |
|
replicas integer |
|
strategy DeploymentStrategy |
Appears In:
| Field | Description |
|---|---|
ObjectSelector ObjectSelector |
|
outputName string |
Appears In:
| Field | Description |
|---|---|
podTemplate PodTemplateSpec |
|
replicas integer |
|
serviceName string |
|
podManagementPolicy PodManagementPolicyType |
PodManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is Parallel, where pods are created in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. The alternative policy is OrderedReady, the default for vanilla kubernetes StatefulSets, where pods are created in increasing order in increasing order (pod-0, then pod-1, etc.) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. |
volumeClaimTemplates PersistentVolumeClaim array |
VolumeClaimTemplates is a list of persistent volume claims to be used by each Pod. Every claim in this list must have a matching volumeMount in one of the containers defined in the PodTemplate. Items defined here take precedence over any default claims added by the operator with the same name. |