Skip to content

Commit

Permalink
chore: have crds in helm chart instead of copying (#1986)
Browse files Browse the repository at this point in the history
The odigos CRD yamls are currently generated in the api module. Whenever
the helm chart should be used for development, we needed to run `cp -r
./api/config/crd/bases/* ./helm/odigos/templates/crds/` to have the helm
repo working.

I think it's nicer to have all the files right in the helm. template,
and remove the need to `cp` in release and deplpoyment. Added a check in
CI to make sure the files are aligned
  • Loading branch information
blumamir authored Dec 14, 2024
1 parent 66d1237 commit 98084f9
Show file tree
Hide file tree
Showing 23 changed files with 2,824 additions and 10 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/verify-api-crds.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,13 @@ jobs:
echo "client files are not up to date. Please run 'make generate-client' and commit the changes."
exit 1
fi
- name: Sync CRDs to Helm
run: make sync-helm-crd
- name: Verify Helm
run: |
if [[ $(git diff --exit-code) ]]; then
git diff
echo "Helm CRDs are not up to date. Please run 'make sync-helm-crd' and commit the changes."
exit 1
fi
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ make deploy
make deploy-odiglet
make deploy-autoscaler
make deploy-collector
make deploy-scheduler
make deploy-instrumentor
make deploy-ui
```

- Deploy odiglet and build instrumentation agents from source code:
Expand Down
4 changes: 3 additions & 1 deletion api/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
2. Run `make generate` to update the auto generated `zz_generated.deepcopy.go` file.
3. Run `make manifests` to update the CRD yaml files in the `config/crd/bases` directory.
4. Run `make generate-client` to update the auto generated files under `api/generated`.
5. Update the code in `cli` module to reflect the changes in the CRD in the `cli/cmd/resources/crds` directory
5. Run `make sync-helm-crd` to sync the CRD yaml files to the helm chart.

you can run `make all` to combine steps 2-5 instead of running them individually.

## CRD versioning

Expand Down
8 changes: 7 additions & 1 deletion api/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SHELL = /usr/bin/env bash -o pipefail
.SHELLFLAGS = -ec

.PHONY: all
all: generate manifests generate-client
all: generate manifests generate-client sync-helm-crd

##@ General

Expand Down Expand Up @@ -90,3 +90,9 @@ generate-client:
GOWORK=off go mod vendor
./hack/update-codegen.sh
rm -rf ./vendor

.PHONY: sync-helm
sync-helm-crd:
@echo "Syncing CRD yamls to Helm repo"
@rm ../helm/odigos/templates/crds/* # remove existing files so we don't get leftovers
@cp -r config/crd/bases/* ../helm/odigos/templates/crds/
1 change: 0 additions & 1 deletion helm/odigos/templates/crds/.gitignore

This file was deleted.

2 changes: 0 additions & 2 deletions helm/odigos/templates/crds/README.md

This file was deleted.

154 changes: 154 additions & 0 deletions helm/odigos/templates/crds/actions.odigos.io_addclusterinfos.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
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: addclusterinfos.actions.odigos.io
spec:
group: actions.odigos.io
names:
kind: AddClusterInfo
listKind: AddClusterInfoList
plural: addclusterinfos
shortNames:
- aci
singular: addclusterinfo
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: AddClusterInfo is the Schema for the addclusterinfo odigos action
API
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:
description: AddClusterInfoSpec defines the desired state of AddClusterInfo
action
properties:
actionName:
type: string
clusterAttributes:
items:
properties:
attributeName:
description: the name of the attribute to insert
type: string
attributeStringValue:
description: |-
if the value is a string, this field should be used.
empty string is a valid value
type: string
required:
- attributeName
- attributeStringValue
type: object
type: array
disabled:
type: boolean
notes:
type: string
signals:
items:
enum:
- LOGS
- TRACES
- METRICS
type: string
type: array
required:
- clusterAttributes
- signals
type: object
status:
description: AddClusterInfoStatus defines the observed state of AddClusterInfo
action
properties:
conditions:
description: |-
Represents the observations of a addclusterinfo's 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: {}
142 changes: 142 additions & 0 deletions helm/odigos/templates/crds/actions.odigos.io_deleteattributes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
labels:
odigos.io/config: "1"
odigos.io/system-object: "true"
name: deleteattributes.actions.odigos.io
spec:
group: actions.odigos.io
names:
kind: DeleteAttribute
listKind: DeleteAttributeList
plural: deleteattributes
shortNames:
- da
singular: deleteattribute
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: DeleteAttribute is the Schema for the DeleteAttribute odigos
action API
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:
description: DeleteAttributeSpec defines the desired state of DeleteAttribute
action
properties:
actionName:
type: string
attributeNamesToDelete:
items:
type: string
type: array
disabled:
type: boolean
notes:
type: string
signals:
items:
enum:
- LOGS
- TRACES
- METRICS
type: string
type: array
required:
- attributeNamesToDelete
- signals
type: object
status:
description: DeleteAttributeStatus defines the observed state of DeleteAttribute
action
properties:
conditions:
description: |-
Represents the observations of a DeleteAttribute's 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 98084f9

Please sign in to comment.