X-Ray

4 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

XRayGroup # GA

XRayGroup is the Schema for managing X-Ray groups.

kubectl get xraygroups · example on GitHub

Example

# XRayGroup — X-Ray
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/xray.html#xraygroup
apiVersion: aws.konfig.io/v1alpha1
kind: XRayGroup
metadata:
  name: example-xraygroup
  namespace: default
spec:
  filterExpression: example
  groupName: example-xraygroup
  insightsConfiguration:
    enabled: true
    notificationsEnabled: true
  providerRef:
    name: example-xraygroup
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`filterExpression`	string	—	FilterExpression defines criteria by which to group traces.
`groupName`	string	yes	GroupName is the case-sensitive name of the group.
`insightsConfiguration`	object	—	InsightsConfiguration configures insights and insight notifications.
`insightsConfiguration.enabled`	boolean	—	Enabled turns on insights for the group.
`insightsConfiguration.notificationsEnabled`	boolean	—	NotificationsEnabled turns on insights notifications.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply at creation time.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the group.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

XRayResourcePolicy # CLOUD CONTROL · AWS::XRay::ResourcePolicy

XRayResourcePolicy manages AWS::XRay::ResourcePolicy through the AWS Cloud Control API.

kubectl get xrayresourcepolicies · example on GitHub

Example

# XRayResourcePolicy — X-Ray
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/xray.html#xrayresourcepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: XRayResourcePolicy
metadata:
  name: example-xrayresourcepolicy
  namespace: default
spec:
  bypassPolicyLockoutCheck: false
  policyDocument: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"],
    "Resource": "*"}]}'
  policyName: example-xrayresourcepolicy
  providerRef:
    name: example-xrayresourcepolicy
    region: us-east-1

Spec

Field	Type	Required	Description
`bypassPolicyLockoutCheck`	boolean	—	A flag to indicate whether to bypass the resource policy lockout safety check
`policyDocument`	string	yes	The resource policy document, which can be up to 5kb in size.
`policyName`	string	yes	The name of the resource policy.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

XRaySamplingRule # GA

XRaySamplingRule is the Schema for managing X-Ray sampling rules.

kubectl get xraysamplingrules · example on GitHub

Example

# XRaySamplingRule — X-Ray
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/xray.html#xraysamplingrule
apiVersion: aws.konfig.io/v1alpha1
kind: XRaySamplingRule
metadata:
  name: example-xraysamplingrule
  namespace: default
spec:
  fixedRate: 1
  host: example
  httpMethod: example
  priority: 1
  providerRef:
    name: example-xraysamplingrule
    region: us-east-1
  reservoirSize: 1
  resourceArn: arn:aws:iam::123456789012:role/example-role
  ruleName: example-xraysamplingrule
  serviceName: example-xraysamplingrule
  serviceType: example
  tags:
    environment: dev
    team: platform
  urlPath: example

Spec

Field	Type	Required	Description
`fixedRate`	number	yes	FixedRate is the fraction of matching requests to instrument, after the reservoir is exhausted (e.g.
`host`	string	—	Host matches the hostname from a request URL.
`httpMethod`	string	—	HTTPMethod matches the HTTP method of a request.
`priority`	integer	yes	Priority of the sampling rule.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`reservoirSize`	integer	yes	ReservoirSize is a fixed number of matching requests to instrument per second, before applying the fixed rate.
`resourceArn`	string	—	ResourceARN matches the ARN of the AWS resource on which the service runs.
`ruleName`	string	yes	RuleName is the name of the sampling rule.
`serviceName`	string	—	ServiceName matches the name that the service uses to identify itself in segments.
`serviceType`	string	—	ServiceType matches the origin that the service uses to identify its type in segments.
`tags`	map<string>	—	Tags are AWS resource tags to apply at creation time.
`urlPath`	string	—	URLPath matches the path from a request URL.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the sampling rule.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

XRayTransactionSearchConfig # CLOUD CONTROL · AWS::XRay::TransactionSearchConfig ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide X-Ray setting. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. XRayTransactionSearchConfig manages AWS::XRay::TransactionSearchConfig through the AWS Cloud Control API.

kubectl get xraytransactionsearchconfigs · example on GitHub

Example

# XRayTransactionSearchConfig — X-Ray
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/xray.html#xraytransactionsearchconfig
apiVersion: aws.konfig.io/v1alpha1
kind: XRayTransactionSearchConfig
metadata:
  name: example-xraytransactionsearchconfig
  namespace: default
spec:
  indexingPercentage: 1
  providerRef:
    name: example-xraytransactionsearchconfig
    region: us-east-1

Spec

Field	Type	Required	Description
`indexingPercentage`	number	—
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

Field	Type	Required	Description
`accountId`	string	—	Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.