Skip to content

Commit

Permalink
rename k8sAttributes action and add status condition (#2424)
Browse files Browse the repository at this point in the history
The original action name was `K8sAttributes` however, we need to supply
singular and plural names for the CRD generations - hence changing its
name to `K8sAttributiesResolver` which has the plural of
`K8sAttributesResolvers`.

Also added status condition for the action.
  • Loading branch information
RonFed authored Feb 11, 2025
1 parent 261a49d commit 4683ffe
Show file tree
Hide file tree
Showing 23 changed files with 716 additions and 293 deletions.
14 changes: 7 additions & 7 deletions api/actions/v1alpha1/k8sattributes_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ type K8sAttributesStatus struct {
//+genclient
//+kubebuilder:object:root=true
//+kubebuilder:subresource:status
//+kubebuilder:resource:path=k8sattributes,scope=Namespaced
//+kubebuilder:resource:path=k8sattributesresolvers,scope=Namespaced
//+kubebuilder:metadata:labels=metadata.labels.odigos.io/config=1
//+kubebuilder:metadata:labels=metadata.labels.odigos.io/system-object=true

// K8sAttributes allows adding an action to collect k8s attributes.
type K8sAttributes struct {
// K8sAttributesResolver allows adding an action to collect k8s attributes.
type K8sAttributesResolver struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Expand All @@ -103,13 +103,13 @@ type K8sAttributes struct {

//+kubebuilder:object:root=true

// K8sAttributesList contains a list of K8sAttributes
type K8sAttributesList struct {
// K8sAttributesResolverList contains a list of K8sAttributes
type K8sAttributesResolverList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []K8sAttributes `json:"items"`
Items []K8sAttributesResolver `json:"items"`
}

func init() {
SchemeBuilder.Register(&K8sAttributes{}, &K8sAttributesList{})
SchemeBuilder.Register(&K8sAttributesResolver{}, &K8sAttributesResolverList{})
}
22 changes: 11 additions & 11 deletions api/actions/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

194 changes: 194 additions & 0 deletions api/config/crd/bases/actions.odigos.io_k8sattributesresolvers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
labels:
metadata.labels.odigos.io/config: "1"
metadata.labels.odigos.io/system-object: "true"
name: k8sattributesresolvers.actions.odigos.io
spec:
group: actions.odigos.io
names:
kind: K8sAttributesResolver
listKind: K8sAttributesResolverList
plural: k8sattributesresolvers
singular: k8sattributesresolver
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: K8sAttributesResolver allows adding an action to collect k8s
attributes.
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
properties:
actionName:
type: string
annotationsAttributes:
description: list of annotations to be extracted from the pod, and
the attribute key to be used for the resource attribute created
from each annotation.
items:
properties:
annotationKey:
description: |-
The label name to be extracted from the pod.
e.g. "kubectl.kubernetes.io/restartedAt"
type: string
attributeKey:
description: |-
The attribute key to be used for the resource attribute created from the label.
e.g. "kubectl.kubernetes.restartedAte"
type: string
required:
- annotationKey
- attributeKey
type: object
type: array
collectClusterUID:
description: Collect the k8s.cluster.uid attribute, which is set to
the uid of the namespace "kube-system"
type: boolean
collectContainerAttributes:
description: |-
Collect the following container related attributes:
k8s.container.name
container.id
container.image.name
container.image.tag
type: boolean
collectWorkloadUID:
description: |-
Collect the following workload UID attributes:
k8s.deployment.uid
k8s.daemonset.uid
k8s.statefulset.uid
type: boolean
disabled:
type: boolean
labelsAttributes:
description: list of labels to be extracted from the pod, and the
attribute key to be used for the resource attribute created from
each label.
items:
properties:
attributeKey:
description: |-
The attribute key to be used for the resource attribute created from the label.
e.g. "app.kubernetes.name"
type: string
labelKey:
description: |-
The label name to be extracted from the pod.
e.g. "app.kubernetes.io/name"
type: string
required:
- attributeKey
- labelKey
type: object
type: array
notes:
type: string
signals:
items:
enum:
- LOGS
- TRACES
- METRICS
type: string
type: array
required:
- signals
type: object
status:
description: K8sAttributesStatus defines the observed state of K8sAttributes
action
properties:
conditions:
description: |-
Represents the observations of a k8sattributes' current state.
Known .status.conditions.type are: "Available", "Progressing"
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
type: object
served: true
storage: true
subresources:
status: {}
Loading

0 comments on commit 4683ffe

Please sign in to comment.