docs: update docs and add deprecation notices

odigos-io · Aug 13, 2024 · f3ce9f3 · f3ce9f3
1 parent b103566
commit f3ce9f3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/api/config/crd/bases/odigos.io_odigosconfigurations.yaml b/api/config/crd/bases/odigos.io_odigosconfigurations.yaml
@@ -17,7 +17,11 @@ spec:
   - name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: OdigosConfiguration is the Schema for the odigos configuration
+        description: |-
+          OdigosConfiguration is the Schema for the odigos configuration
+
+
+          Deprecated: Use common.OdigosConfiguration instead
         properties:
           apiVersion:
             description: |-
@@ -37,11 +41,16 @@ spec:
           metadata:
             type: object
           spec:
-            description: OdigosConfigurationSpec defines the desired state of OdigosConfiguration
+            description: |-
+              OdigosConfigurationSpec defines the desired state of OdigosConfiguration
+
+
+              Deprecated: Use common.OdigosConfiguration instead
             properties:
               autoscalerImage:
                 type: string
               collectorGateway:
+                description: 'Deprecated: Use common.OdigosConfiguration instead'
                 properties:
                   goMemLimitMiB:
                     description: |-

diff --git a/api/odigos/v1alpha1/odigosconfig_types.go b/api/odigos/v1alpha1/odigosconfig_types.go
@@ -7,6 +7,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// Deprecated: Use common.OdigosConfiguration instead
 type CollectorGatewayConfiguration struct {
 	// RequestMemoryMiB is the memory request for the cluster gateway collector deployment.
 	// it will be embedded in the deployment as a resource request of the form "memory: <value>Mi"
@@ -30,6 +31,8 @@ type CollectorGatewayConfiguration struct {
 }
 
 // OdigosConfigurationSpec defines the desired state of OdigosConfiguration
+//
+// Deprecated: Use common.OdigosConfiguration instead
 type OdigosConfigurationSpec struct {
 	OdigosVersion     string                                          `json:"odigosVersion"`
 	ConfigVersion     int                                             `json:"configVersion"`
@@ -55,6 +58,8 @@ type OdigosConfigurationSpec struct {
 //+kubebuilder:object:root=true
 
 // OdigosConfiguration is the Schema for the odigos configuration
+//
+// Deprecated: Use common.OdigosConfiguration instead
 type OdigosConfiguration struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/docs/architecture/troubleshooting.mdx b/docs/architecture/troubleshooting.mdx
@@ -109,8 +109,9 @@ If the instrumentation devices are missing:
 
 The instrumentation devices is selected based on the programming language and the configuration in the global odigos config resource:
 
-```
-kubectl get odigosconfigurations.odigos.io -n odigos-system odigos-config -o yaml
+```bash
+kubectl get configmap -n odigos-system odigos-config -o json | jq -r '.data."config.yaml"' | jq .
+# or, if your environment does not have jq, examine "config.yaml" field under "data" of the configmap
 ```
 
 To examine the resources for a workload, use this as an example: