Skip to content

Latest commit

 

History

History
78 lines (74 loc) · 6.24 KB

README.helm.md

File metadata and controls

78 lines (74 loc) · 6.24 KB

Korifi Helm chart

This documents the Helm chart for Korifi.

The chart is a composition of subcharts, one per component, with each individual component configuration nested under a top-level key named after the component itself. Values under the top-level global key apply to all components. Each component can be excluded from the deployment by the setting its include value to false. See Customizing the Chart Before Installing for details on how to specify values when installing a Helm chart.

Here are all the values that can be set for the chart:

  • adminUserName (String): Name of the admin user that will be bound to the Cloud Foundry Admin role.
  • global
    • rootNamespace (String): Root of the Cloud Foundry namespace hierarchy.
    • debug (Boolean): Enables remote debugging with Delve.
    • defaultAppDomainName (String): Base domain name for application URLs.
    • generateIngressCertificates (Boolean): Use cert-manager to generate self-signed certificates for the API and app endpoints.
    • containerRegistrySecret (String): Name of the Secret to use when pushing or pulling from package, droplet and kpack-build repositories
  • api:
    • include (Boolean): Deploy the API component.
    • replicas (Integer): Number of replicas.
    • resources (Object): ResourceRequirements for the API.
    • apiServer:
      • url (String): API URL.
      • port (Integer): API external port. Defaults to 443.
      • internalPort (Integer): Port used internally by the API container.
      • timeouts: HTTP timeouts.
        • read (Integer)
        • write (Integer)
        • idle (Integer)
        • readHeader (Integer)
    • image (String): Reference to the API container image.
    • lifecycle: Default lifecycle for apps.
      • type (String)
      • stack (String)
      • stagingRequirements:
        • memoryMB (Integer)
        • diskMB (Integer)
    • builderName (String): ID of the builder used to build apps. Defaults to kpack-image-builder.
    • packageRepository (String): The container image repository where app source packages will be stored. For DockerHub, this might be index.docker.io/<username>/packages.
    • userCertificateExpirationWarningDuration (String): Issue a warning if the user certificate provided for login has a long expiry. See time.ParseDuration for details on the format.
    • authProxy: Needed if using a cluster authentication proxy, e.g. Pinniped.
      • host (String): Must be a host string, a host:port pair, or a URL to the base of the apiserver.
      • caCert (String): Proxy's PEM-encoded CA certificate (not as Base64).
  • controllers:
    • include (Boolean): Deploy the controllers component.
    • replicas (Integer): Number of replicas.
    • resources (Object): The ResourceRequirements for the controllers.
    • image (String): Reference to the controllers container image.
    • reconcilers:
      • build (String): ID of the image builder to set on all BuildWorkload objects. Has to match api.builderName. Defaults to kpack-image-builder.
      • app (String): ID of the workload runner to set on all AppWorkload objects.
    • processDefaults:
      • memoryMB (Integer): Default memory limit for the web process.
      • diskQuotaMB (Integer): Default disk quota for the web process.
    • taskTTL (String): How long before the CFTask object is deleted after the task has completed. See time.ParseDuration for details on the format, an additional d suffix for days is supported.
    • workloadsTLSSecret (String): TLS secret used when setting up an app routes.
  • job-task-runner:
    • include (Boolean): Deploy the job-task-runner component.
    • replicas (Integer): Number of replicas.
    • resources (Object): The ResourceRequirements for the job-task-runner.
    • image (String): Reference to the job-task-runner container image.
    • jobTTL (String): How long before the Job backing up a task is deleted after completion. See time.ParseDuration for details on the format, an additional d suffix for days is supported.
  • kpack-image-builder:
    • include (Boolean): Deploy the kpack-image-builder component.
    • replicas (Integer): Number of replicas.
    • resources (Object): The ResourceRequirements for the kpack-image-builder.
    • image (String): Reference to the kpack-image-builder container image.
    • dropletRepository (String): The container image repository where droplets will be stored. For DockerHub, this might be index.docker.io/<username>/droplets.
    • clusterBuilderName (String): The name of the ClusterBuilder Kpack has been configured with. Leave blank to let kpack-image-builder create an example ClusterBuilder.
    • clusterStackBuildImage (String): The image to use for building defined in the ClusterStack. Used when kpack-image-builder is blank.
    • clusterStackRunImage (String): The image to use for running defined in the ClusterStack. Used when kpack-image-builder is blank.
    • builderRepository (String): Container image repository to store the ClusterBuilder image. Required when clusterBuilderName is not provided.
  • statefulset-runner:
    • include (Boolean): Deploy the statefulset-runner component.
    • replicas (Integer): Number of replicas.
    • resources (Object): The ResourceRequirements for the statefulset-runner.
    • image (String): Reference to the statefulset-runner container image.