schema.yaml

x-google-marketplace:
  schemaVersion: v2
  applicationApiVersion: v1beta1
  clusterConstraints:
    k8sVersion: ">=1.18.0"
  publishedVersion: "$TAG"
  publishedVersionMetadata:
    releaseNote: >-
      A regular update.
    releaseTypes:
      - Feature
    recommended: True

  images:
    '':  # Primary image has no name.
      properties:
        image:
          type: FULL
    citrix-k8s-ingress-controller:
      properties:
        cic.image:
          type: FULL
    citrix-adc-metrics-exporter:
      properties:
        exporter.image:
          type: FULL
  deployerServiceAccount:
    description: "Creates app resources, including the MyAppCustomResource CRD."
    roles:
    - type: ClusterRole
      rulesType: CUSTOM
      rules:
      - apiGroups: ['apiextensions.k8s.io']
        resources: ['customresourcedefinitions']
        verbs: ['*']
      - apiGroups: ['networking.k8s.io']
        resources: ['ingressclasses']
        verbs: ['*']
properties:
  name:
    type: string
    x-google-marketplace:
      type: NAME
  namespace:
    type: string
    x-google-marketplace:
      type: NAMESPACE
  license.accept:
    type: string
    title: EULA License
    description: Accept EULA license
    default: 'no'
    enum:
    - 'yes'
    - 'no'
  replicaCount:
    type: integer
    title: Replica
    description: Number of Citrix ADC CPX-CIC pods to be deployed.
    default: 1
  serviceAccount:
    type: string
    x-google-marketplace:
      type: SERVICE_ACCOUNT
      serviceAccount:
        description: "These Permission are required for configuring Citrix ADC CPX according to the current state of the Kubernetes Cluster"
        roles:
        - type: ClusterRole
          rulesType: CUSTOM
          rules:
          - apiGroups: [""]
            resources: ["endpoints", "pods", "secrets", "routes", "nodes", "namespaces", "configmaps", "services"]
            verbs: ["get", "list", "watch"]
          - apiGroups: [""]
            resources: ["services/status"]
            verbs: ["patch"]
          - apiGroups: [""]
            resources: ["events"]
            verbs: ["create"]
          - apiGroups: ["extensions", "networking.k8s.io"]
            resources: ["ingresses"]
            verbs: ["get", "list", "watch"]
          - apiGroups: ["extensions", "networking.k8s.io"]
            resources: ["ingresses/status"]
            verbs: ["patch"]
          - apiGroups: ["networking.k8s.io"]
            resources: ["ingressclasses"]
            verbs: ["get", "list", "watch"]
          - apiGroups: ["apiextensions.k8s.io"]
            resources: ["customresourcedefinitions"]
            verbs: ["get", "list", "watch"]
          - apiGroups: ["apps"]
            resources: ["deployments"]
            verbs: ["get", "list", "watch"]
          - apiGroups: ["citrix.com"]
            resources: ["rewritepolicies", "continuousdeployments", "authpolicies", "ratelimits", "listeners", "httproutes", "wafs", "apigatewaypolicies", "bots", "corspolicies", "appqoepolicies"]
            verbs: ["get", "list", "watch", "create", "delete", "patch"]
          - apiGroups: ["citrix.com"]
            resources: ["rewritepolicies/status", "continuousdeployments/status", "authpolicies/status", "ratelimits/status", "listeners/status", "httproutes/status", "wafs/status", "apigatewaypolicies/status", "bots/status", "corspolicies/status", "appqoepolicies/status"]
            verbs: ["patch"]
          - apiGroups: ["citrix.com"]
            resources: ["vips"]
            verbs: ["get", "list", "watch", "create", "delete"]
          - apiGroups: ["crd.projectcalico.org"]
            resources: ["ipamblocks"]
            verbs: ["get", "list", "watch"]
  ADMSettings.licenseServerIP:
    type: string
    title: Citrix Application Delivery Management (ADM) IP address to license Citrix ADC CPX
    description: Provide the Citrix Application Delivery Management (ADM) IP address to license Citrix ADC CPX.
  ADMSettings.licenseServerPort:
    type: integer
    title: Citrix ADM port
    description: Citrix ADM port if non-default port is used.
    default: 27000
    minimum: 0
    maximum: 65535
  ADMSettings.ADMIP:
    type: string
    title: Citrix Application Delivery Management (ADM) IP address
    description: Citrix Application Delivery Management (ADM) IP address.
  ADMSettings.ADMFingerPrint:
    type: string
    title: Citrix Application Delivery Management (ADM) Finger Print
    description: Citrix Application Delivery Management (ADM) Finger Print.
  ADMSettings.loginSecret:
    type: string
    title: The Kubernetes secret name to login to the ADM
    description: The Kubernetes secret name created using ADM credential to login to the ADM.
  ADMSettings.bandWidthLicense:
    type: boolean
    title: Want to use bandwidth based licensing for Citrix ADC CPX?
    description: Set to True if you want to use bandwidth based licensing for Citrix ADC CPX.
    default: False
  ADMSettings.bandWidth:
    type: string
    title: Bandwidth capacity for Citrix ADC CPX
    description: Desired bandwidth capacity to be set for Citrix ADC CPX in Mbps.
  ADMSettings.vCPULicense:
    type: boolean
    title: Want to use vCPU based licensing for Citrix ADC CPX.
    description: Set to True if you want to use vCPU based licensing for Citrix ADC CPX.
    default: False
  ADMSettings.cpxCores:
    type: integer
    title: Desired number of vCPU to be set for Citrix ADC CPX
    description: Desired number of vCPU to be set for Citrix ADC CPX.
    default: 1
  cic.required:
    type: boolean
    title: Citrix Ingress Controller
    description: Set if CIC is required for Citrix ADC CPX
    default: True
  nsProtocol:
    type: string
    title: Protocol for NITRO
    description: Protocol used for Citrix ADC NITRO.
    default: HTTP
    enum:
    - "HTTP"
    - "HTTPS"
  logLevel:
    type: string
    title: Log level of Citrix ingress controller
    description: Level of logs generated by Citrix ingress controller
    default: INFO
    enum:
    - "CRITICAL"
    - "ERROR"
    - "WARNING"
    - "INFO"
    - "DEBUG"
    - "TRACE"
  jsonLog:
    type: boolean
    title: Log format in JSON
    description: Set this argument to True if CIC log messages are required in JSON format
    default: False
  entityPrefix:
    type: string
    title: Prefix
    description: The prefix for the resources on the Citrix ADC CPX.
    default: k8s
  nitroReadTimeout:
    type: integer
    title: Nitro Timeout
    description: The nitro Read timeout in seconds.
    default: 20
  kubernetesURL:
    type: string
    title: Kubernetes URL
    description: The kube-apiserver url that CIC uses to register the events. If the value is not specified, CIC uses the internal kube-apiserver IP address.
  disableAPIServerCertVerify:
    type: boolean
    title: Disable API Server Cert Verification
    description: Set this parameter to True for disabling API Server certificate verification.
    default: False
  ingressClass:
    type: string
    title: Ingress Class
    description: Please provide name of the Ingress Class if needs to be supported by Citrix Ingress Controller.
  setAsDefaultIngressClass:
    type: boolean
    title: Set as Default Ingress Class
    description: Set the IngressClass object as default ingress class. New Ingresses without an "ingressClassName" field specified will be assigned the class specified in ingressClass. Applicable only for Kubernetes versions >= 1.19.
    default: False
  updateIngressStatus:
    type: boolean
    title: Update Ingress Status
    description: Set this argurment if Status.LoadBalancer.Ingress field of the Ingress resources managed by the Citrix ingress controller needs to be updated with allocated IP addresses.
    default: False
  defaultSSLCertSecret:
    type: string
    title: Default SSL Certificate Secret Name.
    description: Provide Kubernetes secret name that needs to be used as a default non-SNI certificate in Citrix ADC CPX.
  nsHTTP2ServerSide:
    type: string
    title: HTTP2 for Citrix ADC CPX service group
    description: Set this argument to ON for enabling HTTP2 for Citrix ADC CPX service group configurations.
    default: 'OFF'
    enum:
    - 'OFF'
    - 'ON'
  nsCookieVersion:
    type: string
    title: Persistence Cookie Version
    description: Specify the persistence cookie version.
    default: '0'
    enum:
    - '0'
    - '1'
  nsConfigDnsRec:
    type: boolean
    title: Enable DNS address record addition through ingress.
    description: Set to True to enable DNS address Record addition in ADC through Ingress.
    default: False
  nsSvcLbDnsRec:
    type: boolean
    title:  Enable DNS address record addition through service type LB.
    description: Set to True to enable DNS address Record addition in ADC through Type Load Balancer Service
    default: False
  nsDnsNameserver:
    type: string
    title: DNS Nameservers
    description: To add DNS Nameservers in ADC
  nsLbHashAlgo.required:
    type: boolean
    title: Enable LB consistent hashing algorithm
    description: Set this value to enable the LB consistent hashing Algorithm
    default: False
  nsLbHashlgo.hashFingers:
    type: integer
    title: Number of fingers for Hash
    description: Specify the number of fingers to be used for hashing algorithm.
    default: 256
    minimum: 1
    maximum: 1024
  nsLbHashAlgo.hashAlgorithm:
    type: string
    title: Hash Algorithm
    description: Specifies the supported hashing algorithm.
    default: 'DEFAULT'
    enum:
    - 'DEFAULT'
    - 'JARH'
    - 'PRAC'
  ipam:
    type: boolean
    title: Using IPAM Controller?
    description: Set this argument if you want to use the IPAM controller to automatically allocate an IP address to the service of type LoadBalancer.
    default: False
  serviceType.loadBalancer.enabled:
    type: boolean
    title: Want Citrix ADC CPX service to be of type LoadBalancer?
    description: Set this argument if you want servicetype of Citrix ADC CPX service to be LoadBalancer.
    default: False
  serviceType.nodePort.enabled:
    type: boolean
    title: Want Citrix ADC CPX service to be of type NodePort?
    description: Set this argument if you want servicetype of Citrix ADC CPX service to be NodePort.
    default: False
  serviceType.nodePort.httpPort:
    type: integer
    title: Specify the HTTP nodeport to be used for NodePort Citrix ADC CPX service
    description: Specify the HTTP nodeport to be used for NodePort Citrix ADC CPX service.
    minimum: 0
    maximum: 65535
  serviceType.nodePort.httpsPort:
    type: integer
    title: Specify the HTTPS nodeport to be used for NodePort Citrix ADC CPX service
    description: Specify the HTTPS nodeport to be used for NodePort Citrix ADC CPX service.
    minimum: 0
    maximum: 65535
  serviceSpec.externalTrafficPolicy:
    type: string
    title: External Traffic Policy
    description: Use this parameter to provide externalTrafficPolicy for Citrix ADC CPX service of type LoadBalancer or NodePort.
    default: 'Cluster'
    enum:
    - 'Cluster'
    - 'Local'
  serviceSpec.loadBalancerIP:
    type: string
    title: Load Balancer IP
    description: Use this parameter to provide LoadBalancer IP to Citrix ADC CPX service of type LoadBalancer.
  exporter.required:
    type: boolean
    title: Prometheus Exporter required?
    description: Set if exporter is needed with Citrix ADC CPX.
    default: False
  exporter.ports.containerPort:
    type: integer
    title: Prometheus Exporter Port
    description: Specify on which port metrics collected by the exporter should be exposed.
    default: 8888
    minimum: 0
    maximum: 65535
  crd.install:
    type: boolean
    title: Install CRDs provided by Citrix
    description: Unset this argument if you don't want to install CustomResourceDefinitions which are consumed by Citrix ingress contoller which is running along Citrix ADC CPX.
    default: True
  crds.retainOnDelete:
    type: boolean
    title: Retain CRDs on delete.
    description: Set this argument if you want to retain CustomResourceDefinitions even after uninstalling Citrix ADC CPX with ingress contoller. This will avoid data-loss of Custom Resource Objects created before uninstallation.
    default: False
  analyticsConfig.required:
    type: boolean
    title: COE Config Required?
    description: Set this to True if you want to configure Citrix ADC CPX to send metrics and transaction records to COE.
    default: False
  analyticsConfig.distributedTracing.enable:
    type: boolean
    title: Enable OpenTracing in Citrix ADC
    description: Set this value to True to enable OpenTracing in Citrix ADC CPX.
    default: False
  analyticsConfig.distributedTracing.samplingrate:
    type: integer
    title: OpenTracing sampling rate in percentage
    description: Specifies the OpenTracing sampling rate in percentage.
    default: 100
    minimum: 0
    maximum: 100
  analyticsConfig.endpoint.server:
    type: string
    title: IP address or DNS address of the analytics server
    description: Set this value as the IP address or DNS address of the analytics server.
  analyticsConfig.endpoint.service:
    type: string
    title: IP address or DNS address of the analytics service in Kubernetes.
    description: Set this value as the IP address or service name with namespace of the analytics service deployed in k8s environment. Format is "namespace/servicename".
  analyticsConfig.timeseries.port:
    type: integer
    title: Port used to expose COE service for timeseries endpoint
    description: Specify the port used to expose COE service outside cluster for timeseries endpoint.
    default: 30002
    minimum: 0
    maximum: 65535
  analyticsConfig.timeseries.metrics.enable:
    type: boolean
    title: Enable sending metrics from Citrix ADC CPX
    description: Set this value to True to enable sending metrics from Citrix ADC CPX.
    default: False
  analyticsConfig.timeseries.metrics.mode:
    type: string
    title: Specifies the mode of metric endpoint.
    description: Specifies the mode of metric endpoint.
    default: avro
  analyticsConfig.timeseries.auditlogs.enable:
    type: boolean
    title: Export audit log data from Citrix ADC CPX
    description: Set this value to True to export audit log data from Citrix ADC CPX.
    default: False
  analyticsConfig.timeseries.events.enable:
    type: boolean
    title: Export events from the Citrix ADC CPX
    description: Set this value to True to export events from the Citrix ADC CPX.
    default: False
  analyticsConfig.transactions.enable:
    type: boolean
    title: Export transactions from Citrix ADC CPX.
    description: Set this value to True to export transactions from Citrix ADC CPX.
    default: False
  analyticsConfig.transactions.port:
    type: integer
    title: Port used to expose COE service for transaction endpoint.
    description: Specify the port used to expose COE service outside cluster for transaction endpoint.
    default: 30001
    minimum: 0
    maximum: 65535
  nodeSelector.key:
    type: string
    title: Provide Node Selector Key for Citrix ADC CPX with Ingress Contoller Pod
    description: Node label key to be used for nodeSelector option in Citrix ADC CPX with Ingress Contoller Pod.
  nodeSelector.value:
    type: string
    title: Provide Node Selector Value for Citrix ADC CPX with Ingress Contoller Pod
    description: Node label value to be used for nodeSelector option in Citrix ADC CPX with Ingress Contoller Pod.
  appUid:
    type: string
    x-google-marketplace:
      type: APPLICATION_UID
      applicationUid:
        generatedProperties:
          createApplicationBoolean: global.application.create
required:
- name
- namespace
- cic.required
- serviceAccount
- exporter.required
- analyticsConfig.required