Introduces XFF configuration support for Istio via CRD (kyma-project#…

…16103) * Add Istio CRD to installation and tech ref docs * Some desciption/text adaptations * Small crd yaml update * Update docs/05-technical-reference/00-custom-resources/oper-01-istio.md Co-authored-by: Iwona Langer <[email protected]> * Update docs/05-technical-reference/00-custom-resources/oper-01-istio.md Co-authored-by: Iwona Langer <[email protected]> * Update docs/05-technical-reference/00-custom-resources/oper-01-istio.md Co-authored-by: Iwona Langer <[email protected]> * Apply suggestions from code review Co-authored-by: Iwona Langer <[email protected]>
lindnerby · Nov 18, 2022 · e7f4d6d · e7f4d6d
1 parent aaacb1d
commit e7f4d6d
Show file tree

Hide file tree

Showing 3 changed files with 171 additions and 0 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -42,6 +42,7 @@
 /installation/resources/crds/application-connector  @VOID404 @akgalwas @koala7659 @franpog859 @mvshao
 /installation/resources/crds/compass-runtime-agent  @VOID404 @akgalwas @koala7659 @franpog859 @mvshao
 /installation/resources/crds/eventing @k15r @nachtmaar @marcobebway @mfaizanse @friedrichwilken @vladislavpaskar @raypinto @lilitgh @muralov
+/installation/resources/crds/istio @strekm @werdes72 @dariusztutaj @cnvergence @barchw @videlov @triffer
 /installation/resources/crds/monitoring @a-thaler @rakesh-garimella @skhalash @chrkl @lindnerby @dennis-ge @lilitgh @hisarbalik
 /installation/resources/crds/ory @strekm @werdes72 @dariusztutaj @cnvergence @barchw @videlov @triffer
 /installation/resources/crds/serverless @m00g3n @pPrecel @dbadura @kwiatekus @moelsayed @cortey @anoipm

diff --git a/docs/05-technical-reference/00-custom-resources/oper-01-istio.md b/docs/05-technical-reference/00-custom-resources/oper-01-istio.md
@@ -0,0 +1,33 @@
+---
+title: Istio
+type: Custom Resource
+---
+
+The `istios.operator.kyma-project.io` CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format the Reconciler uses to configure and install Istio. To get the up-to-date CRD and show the output in the `yaml` format, run this command:
+
+```shell
+kubectl get crd istios.operator.kyma-project.io -o yaml
+```
+
+## Sample custom resource
+
+This is a sample Istio custom resource (CR) that the Reconciler uses to configure and install Istio. This example shows the single supported **numTrustedProxies** configuration setting. There must be only one Istio CR on the cluster.
+
+```yaml
+apiVersion: operator.kyma-project.io/v1alpha1
+kind: Istio
+metadata:
+  name: istio
+  labels:
+    app.kubernetes.io/name: istio
+spec:
+  config:
+    numTrustedProxies: 1
+```
+
+This table lists all the possible parameters of a given resource together with their descriptions:
+
+| Field   |      Mandatory      |  Description |
+|---|:---:|---|
+| **metadata.name** | **YES** | Specifies the name of the Istio Manager CR. |
+| **spec.config.numTrustedProxies** | **NO** | Specifies the number of trusted proxies; for more information, read the [Istio documentation](https://istio.io/latest/docs/ops/configuration/traffic-management/network-topologies/). |
diff --git a/installation/resources/crds/istio/istios.operator.crd.yaml b/installation/resources/crds/istio/istios.operator.crd.yaml
@@ -0,0 +1,137 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.9.2
+  creationTimestamp: null
+  labels:
+    app.kubernetes.io/component: istio-operator.kyma-project.io
+  name: istios.operator.kyma-project.io
+spec:
+  group: operator.kyma-project.io
+  names:
+    kind: Istio
+    listKind: IstioList
+    plural: istios
+    singular: istio
+  scope: Namespaced
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: Contains Istio CR specification and current status.
+        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: Defines the desired specification for installing or updating
+              Istio.
+            properties:
+              config:
+                description: Configuration for the Istio installation.
+                properties:
+                  numTrustedProxies:
+                    description: Defines the number of trusted proxies deployed in
+                      front of the Istio gateway proxy.
+                    type: integer
+                type: object
+            type: object
+          status:
+            description: Status defines the observed state of CustomObject.
+            properties:
+              conditions:
+                description: Conditions associated with CustomStatus.
+                items:
+                  description: "Condition contains details for one aspect of the current
+                    state of this API Resource. --- This struct is intended for direct
+                    use as an array at the field path .status.conditions.  For example,
+                    \n type FooStatus struct{ // Represents the observations of a
+                    foo's current state. // Known .status.conditions.type are: \"Available\",
+                    \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
+                    // +listType=map // +listMapKey=type Conditions []metav1.Condition
+                    `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
+                    protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
+                  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.
+                        --- Many .condition.type values are consistent across resources
+                        like Available, but because arbitrary conditions can be useful
+                        (see .node.status.conditions), the ability to deconflict is
+                        important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+                      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
+              state:
+                description: State signifies current state of CustomObject. Value
+                  can be one of ("Ready", "Processing", "Error", "Deleting").
+                enum:
+                - Processing
+                - Deleting
+                - Ready
+                - Error
+                type: string
+            required:
+            - state
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}