From 435dc4d845f78503eff25c357693cc6f9335b19b Mon Sep 17 00:00:00 2001 From: innoavator Date: Wed, 18 Dec 2024 06:27:31 +0000 Subject: [PATCH] Update README.md with readme-generator-for-helm Signed-off-by: innoavator --- charts/tfy-k8s-aws-eks-inframold/README.md | 201 ++++++++++++++++++ charts/tfy-k8s-azure-aks-inframold/README.md | 174 +++++++++++++++ charts/tfy-k8s-civo-talos-inframold/README.md | 174 +++++++++++++++ .../README.md | 174 +++++++++++++++ charts/tfy-k8s-generic-inframold/README.md | 174 +++++++++++++++ 5 files changed, 897 insertions(+) diff --git a/charts/tfy-k8s-aws-eks-inframold/README.md b/charts/tfy-k8s-aws-eks-inframold/README.md index cde4c3058..5dd7467e1 100644 --- a/charts/tfy-k8s-aws-eks-inframold/README.md +++ b/charts/tfy-k8s-aws-eks-inframold/README.md @@ -2,3 +2,204 @@ Inframold, the superchart that configure your cluster on aws for truefoundry. ## Parameters + +### Global Parameters + +| Name | Description | Value | +| ----------------- | ---------------------------------------- | ----- | +| `tenantName` | Parameters for tenantName | `""` | +| `controlPlaneURL` | Parameters for controlPlaneURL | `""` | +| `clusterName` | Name of the cluster | `""` | +| `tolerations` | Tolerations for the all chart components | `[]` | +| `affinity` | Affinity for the all chart components | `{}` | + +### argocd parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------ | +| `argocd.enabled` | Flag to enable ArgoCD | `true` | +| `argocd.valuesOverride` | Config override from default config values | `{}` | + +### argoWorkflows parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `argoWorkflows.enabled` | Flag to enable Argo Workflows | `true` | +| `argoWorkflows.valuesOverride` | Config override from default config values | `{}` | + +### argoRollouts parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `argoRollouts.enabled` | Flag to enable Argo Rollouts | `true` | +| `argoRollouts.valuesOverride` | Config override from default config values | `{}` | + +### notebookController parameters + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | ------------------ | +| `notebookController.enabled` | Flag to enable Notebook Controller | `false` | +| `notebookController.defaultStorageClass` | Default storage class for Notebook Controller | `""` | +| `notebookController.notebookBaseDomainUrl` | Base domain URL for Notebook Controller | `` | +| `notebookController.valuesOverride` | Config override from default config values | `{}` | + +### certManager parameters + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------ | ------- | +| `certManager.enabled` | Flag to enable Cert Manager | `false` | +| `certManager.valuesOverride` | Config override from default config values | `{}` | + +### metricsServer parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `metricsServer.enabled` | Flag to enable Metrics Server | `true` | +| `metricsServer.enabled` | Flag to enable Metrics Server | `true` | +| `metricsServer.valuesOverride` | Config override from default config values | `{}` | + +### AWS parameters + +| Name | Description | Value | +| ---------------------------------------------- | ------------------------------------------- | ------- | +| `aws.awsLoadBalancerController.enabled` | Flag to enable AWS Load Balancer Controller | `true` | +| `aws.awsLoadBalancerController.roleArn` | Role ARN for AWS Load Balancer Controller | `""` | +| `aws.awsLoadBalancerController.vpcId` | VPC ID of AWS EKS cluster | `""` | +| `aws.awsLoadBalancerController.region` | region of AWS EKS cluster | `""` | +| `aws.awsLoadBalancerController.valuesOverride` | Config override from default config values | `{}` | +| `aws.karpenter.enabled` | Flag to enable Karpenter | `true` | +| `aws.karpenter.clusterEndpoint` | Cluster endpoint for Karpenter | `""` | +| `aws.karpenter.roleArn` | Role ARN for Karpenter | `""` | +| `aws.karpenter.instanceProfile` | Instance profile for Karpenter | `""` | +| `aws.karpenter.defaultZones` | Default zones list for Karpenter | `[]` | +| `aws.karpenter.webhook.enabled` | Flag to enable Karpenter webhook | `false` | +| `aws.karpenter.interruptionQueue` | Interruption queue name for Karpenter | `""` | +| `aws.karpenter.valuesOverride` | Config override from default config values | `{}` | +| `aws.awsEbsCsiDriver.enabled` | Flag to enable AWS EBS CSI Driver | `true` | +| `aws.awsEbsCsiDriver.roleArn` | Role ARN for AWS EBS CSI Driver | `""` | +| `aws.awsEbsCsiDriver.valuesOverride` | Config override from default config values | `{}` | +| `aws.awsEfsCsiDriver.enabled` | Flag to enable AWS EFS CSI Driver | `true` | +| `aws.awsEfsCsiDriver.fileSystemId` | File system ID for AWS EFS CSI Driver | `""` | +| `aws.awsEfsCsiDriver.roleArn` | Role ARN for AWS EFS CSI Driver | `""` | +| `aws.awsEfsCsiDriver.valuesOverride` | Config override from default config values | `{}` | +| `aws.inferentia.enabled` | Flag to enable Inferentia | `false` | +| `aws.inferentia.valuesOverride` | Config override from default config values | `{}` | + +### gpu parameters + +| Name | Description | Value | +| -------------------- | ------------------------------------------ | -------- | +| `gpu.enabled` | Flag to enable Tfy GPU Operator | `true` | +| `gpu.clusterType` | Cluster type for Tfy GPU Operator | `awsEks` | +| `gpu.valuesOverride` | Config override from default config values | `{}` | + +### truefoundry parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------- | +| `truefoundry.enabled` | Flag to enable TrueFoundry | `false` | +| `truefoundry.devMode.enabled` | Flag to enable TrueFoundry Dev mode | `false` | +| `truefoundry.valuesOverride` | Config override from default config values | `{}` | + +### truefoundryBootstrap parameters + +| Name | Description | Value | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------ | +| `truefoundry.truefoundryBootstrap.enabled` | Flag to enable bootstrap job to prep cluster for truefoundry installation | `true` | + +### Truefoundry virtual service parameters + +| Name | Description | Value | +| ------------------------------------- | -------------------------------------------------- | ------- | +| `truefoundry.virtualservice.enabled` | Flag to enable virtualservice | `false` | +| `truefoundry.virtualservice.hosts` | Hosts for truefoundry virtualservice | `[]` | +| `truefoundry.virtualservice.gateways` | Istio gateways to be configured for virtualservice | `[]` | + +### database. Can be left empty if using the dev mode parameters + +| Name | Description | Value | +| -------------------------------------------- | ---------------------------------------------------------- | ----- | +| `truefoundry.database.host` | Hostname of the database | `""` | +| `truefoundry.database.name` | Name of the database | `""` | +| `truefoundry.database.username` | Username of the database | `""` | +| `truefoundry.database.password` | Password of the database | `""` | +| `truefoundry.tfyApiKey` | API Key for TrueFoundry | `""` | +| `truefoundry.truefoundryImagePullConfigJSON` | Json config for authenticating to the TrueFoundry registry | `""` | + +### loki parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `loki.enabled` | Flag to enable Loki | `true` | +| `loki.valuesOverride` | Config override from default config values | `{}` | + +### istio parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `istio.enabled` | Flag to enable Istio | `true` | +| `istio.enabled` | Flag to enable Istio Base | `true` | +| `istio.base.valuesOverride` | Config override from default config values | `{}` | +| `istio.gateway.valuesOverride` | Config override from default config values | `{}` | + +### istio discovery parameters + +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------- | ---------------------- | +| `istio.discovery.hub` | Hub for the istio image | `gcr.io/istio-release` | +| `istio.discovery.tag` | Tag for the istio image | `1.21.1-distroless` | +| `istio.discovery.valuesOverride` | Config override from default config values | `{}` | +| `istio.tfyGateway.httpsRedirect` | Flag to enable HTTPS redirect for Istio Gateway | `true` | + +### keda parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `keda.enabled` | Flag to enable Keda | `true` | +| `keda.valuesOverride` | Config override from default config values | `{}` | + +### kubecost parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------ | ------ | +| `kubecost.enabled` | Flag to enable Kubecost | `true` | +| `kubecost.valuesOverride` | Config override from default config values | `{}` | + +### prometheus parameters + +| Name | Description | Value | +| --------------------------- | ------------------------------------------ | ------ | +| `prometheus.enabled` | Flag to enable Prometheus | `true` | +| `prometheus.valuesOverride` | Config override from default config values | `{}` | + +### grafana parameters + +| Name | Description | Value | +| ------------------------ | ------------------------------------------ | ------- | +| `grafana.enabled` | Flag to enable Grafana | `false` | +| `grafana.valuesOverride` | Config override from default config values | `{}` | + +### tfyAgent parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `tfyAgent.enabled` | Flag to enable Tfy Agent | `true` | +| `tfyAgent.clusterToken` | cluster token | `""` | +| `tfyAgent.valuesOverride` | Config override from default config values | `{}` | +| `tfyAgent.clusterTokenSecret` | Secret name for cluster token | `""` | + +### elasti parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------- | +| `elasti.enabled` | Flag to enable Elasti | `false` | +| `elasti.valuesOverride` | Config override from default config values | `{}` | + +### jspolicy parameters + +| Name | Description | Value | +| -------------------------------- | -------------------------------------------------------- | ------- | +| `jspolicy.enabled` | Flag to enable jspolicy. No policy is applied by default | `false` | +| `jspolicy.enabled` | Flag to enable jspolicy | `false` | +| `jspolicy.valuesOverride` | Config override from default config values | `{}` | +| `jspolicy.config.valuesOverride` | Config override from default config values | `{}` | diff --git a/charts/tfy-k8s-azure-aks-inframold/README.md b/charts/tfy-k8s-azure-aks-inframold/README.md index 4e2b77785..6980bdc3f 100644 --- a/charts/tfy-k8s-azure-aks-inframold/README.md +++ b/charts/tfy-k8s-azure-aks-inframold/README.md @@ -2,3 +2,177 @@ Inframold, the superchart that configure your cluster on azure for truefoundry. ## Parameters + +### Global Parameters + +| Name | Description | Value | +| ----------------- | ---------------------------------------- | ----- | +| `tenantName` | Parameters for tenantName | `""` | +| `controlPlaneURL` | Parameters for controlPlaneURL | `""` | +| `clusterName` | Name of the cluster | `""` | +| `tolerations` | Tolerations for the all chart components | `[]` | +| `affinity` | Affinity for the all chart components | `{}` | + +### argocd parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------ | +| `argocd.enabled` | Flag to enable ArgoCD | `true` | +| `argocd.valuesOverride` | Config override from default config values | `{}` | + +### argoWorkflows parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `argoWorkflows.enabled` | Flag to enable Argo Workflows | `true` | +| `argoWorkflows.valuesOverride` | Config override from default config values | `{}` | + +### argoRollouts parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `argoRollouts.enabled` | Flag to enable Argo Rollouts | `true` | +| `argoRollouts.valuesOverride` | Config override from default config values | `{}` | + +### notebookController parameters + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | ------------------ | +| `notebookController.enabled` | Flag to enable Notebook Controller | `false` | +| `notebookController.defaultStorageClass` | Default storage class for Notebook Controller | `""` | +| `notebookController.notebookBaseDomainUrl` | Base domain URL for Notebook Controller | `` | +| `notebookController.valuesOverride` | Config override from default config values | `{}` | + +### certManager parameters + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------ | ------- | +| `certManager.enabled` | Flag to enable Cert Manager | `false` | +| `certManager.valuesOverride` | Config override from default config values | `{}` | + +### metricsServer parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------- | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.valuesOverride` | Config override from default config values | `{}` | + +### gpu parameters + +| Name | Description | Value | +| -------------------- | ------------------------------------------ | ---------- | +| `gpu.enabled` | Flag to enable Tfy GPU Operator | `true` | +| `gpu.clusterType` | Cluster type for Tfy GPU Operator | `azureAks` | +| `gpu.valuesOverride` | Config override from default config values | `{}` | + +### truefoundry parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------- | +| `truefoundry.enabled` | Flag to enable TrueFoundry | `false` | +| `truefoundry.devMode.enabled` | Flag to enable TrueFoundry Dev mode | `false` | +| `truefoundry.valuesOverride` | Config override from default config values | `{}` | + +### truefoundryBootstrap parameters + +| Name | Description | Value | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------ | +| `truefoundry.truefoundryBootstrap.enabled` | Flag to enable bootstrap job to prep cluster for truefoundry installation | `true` | + +### Truefoundry virtual service parameters + +| Name | Description | Value | +| ------------------------------------- | -------------------------------------------------- | ------- | +| `truefoundry.virtualservice.enabled` | Flag to enable virtualservice | `false` | +| `truefoundry.virtualservice.hosts` | Hosts for truefoundry virtualservice | `[]` | +| `truefoundry.virtualservice.gateways` | Istio gateways to be configured for virtualservice | `[]` | + +### database. Can be left empty if using the dev mode parameters + +| Name | Description | Value | +| -------------------------------------------- | ---------------------------------------------------------- | ----- | +| `truefoundry.database.host` | Hostname of the database | `""` | +| `truefoundry.database.name` | Name of the database | `""` | +| `truefoundry.database.username` | Username of the database | `""` | +| `truefoundry.database.password` | Password of the database | `""` | +| `truefoundry.tfyApiKey` | API Key for TrueFoundry | `""` | +| `truefoundry.truefoundryImagePullConfigJSON` | Json config for authenticating to the TrueFoundry registry | `""` | + +### loki parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `loki.enabled` | Flag to enable Loki | `true` | +| `loki.valuesOverride` | Config override from default config values | `{}` | + +### istio parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `istio.enabled` | Flag to enable Istio | `true` | +| `istio.enabled` | Flag to enable Istio Base | `true` | +| `istio.base.valuesOverride` | Config override from default config values | `{}` | +| `istio.gateway.valuesOverride` | Config override from default config values | `{}` | + +### istio discovery parameters + +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------- | ---------------------- | +| `istio.discovery.hub` | Hub for the istio image | `gcr.io/istio-release` | +| `istio.discovery.tag` | Tag for the istio image | `1.21.1-distroless` | +| `istio.discovery.valuesOverride` | Config override from default config values | `{}` | +| `istio.tfyGateway.httpsRedirect` | Flag to enable HTTPS redirect for Istio Gateway | `true` | + +### keda parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `keda.enabled` | Flag to enable Keda | `true` | +| `keda.valuesOverride` | Config override from default config values | `{}` | + +### kubecost parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------ | ------ | +| `kubecost.enabled` | Flag to enable Kubecost | `true` | +| `kubecost.valuesOverride` | Config override from default config values | `{}` | + +### prometheus parameters + +| Name | Description | Value | +| --------------------------- | ------------------------------------------ | ------ | +| `prometheus.enabled` | Flag to enable Prometheus | `true` | +| `prometheus.valuesOverride` | Config override from default config values | `{}` | + +### grafana parameters + +| Name | Description | Value | +| ------------------------ | ------------------------------------------ | ------- | +| `grafana.enabled` | Flag to enable Grafana | `false` | +| `grafana.valuesOverride` | Config override from default config values | `{}` | + +### tfyAgent parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `tfyAgent.enabled` | Flag to enable Tfy Agent | `true` | +| `tfyAgent.clusterToken` | cluster token | `""` | +| `tfyAgent.valuesOverride` | Config override from default config values | `{}` | +| `tfyAgent.clusterTokenSecret` | Secret name for cluster token | `""` | + +### elasti parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------- | +| `elasti.enabled` | Flag to enable Elasti | `false` | +| `elasti.valuesOverride` | Config override from default config values | `{}` | + +### jspolicy parameters + +| Name | Description | Value | +| -------------------------------- | -------------------------------------------------------- | ------- | +| `jspolicy.enabled` | Flag to enable jspolicy. No policy is applied by default | `false` | +| `jspolicy.enabled` | Flag to enable jspolicy | `false` | +| `jspolicy.valuesOverride` | Config override from default config values | `{}` | +| `jspolicy.config.valuesOverride` | Config override from default config values | `{}` | diff --git a/charts/tfy-k8s-civo-talos-inframold/README.md b/charts/tfy-k8s-civo-talos-inframold/README.md index d4aab5fb9..e714f14ed 100644 --- a/charts/tfy-k8s-civo-talos-inframold/README.md +++ b/charts/tfy-k8s-civo-talos-inframold/README.md @@ -2,3 +2,177 @@ Inframold, the superchart that configure your cluster on civo for truefoundry. ## Parameters + +### Global Parameters + +| Name | Description | Value | +| ----------------- | ---------------------------------------- | ----- | +| `tenantName` | Parameters for tenantName | `""` | +| `controlPlaneURL` | Parameters for controlPlaneURL | `""` | +| `clusterName` | Name of the cluster | `""` | +| `tolerations` | Tolerations for the all chart components | `[]` | +| `affinity` | Affinity for the all chart components | `{}` | + +### argocd parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------ | +| `argocd.enabled` | Flag to enable ArgoCD | `true` | +| `argocd.valuesOverride` | Config override from default config values | `{}` | + +### argoWorkflows parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `argoWorkflows.enabled` | Flag to enable Argo Workflows | `true` | +| `argoWorkflows.valuesOverride` | Config override from default config values | `{}` | + +### argoRollouts parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `argoRollouts.enabled` | Flag to enable Argo Rollouts | `true` | +| `argoRollouts.valuesOverride` | Config override from default config values | `{}` | + +### notebookController parameters + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | ------------------ | +| `notebookController.enabled` | Flag to enable Notebook Controller | `false` | +| `notebookController.defaultStorageClass` | Default storage class for Notebook Controller | `""` | +| `notebookController.notebookBaseDomainUrl` | Base domain URL for Notebook Controller | `` | +| `notebookController.valuesOverride` | Config override from default config values | `{}` | + +### certManager parameters + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------ | ------- | +| `certManager.enabled` | Flag to enable Cert Manager | `false` | +| `certManager.valuesOverride` | Config override from default config values | `{}` | + +### metricsServer parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------- | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.valuesOverride` | Config override from default config values | `{}` | + +### gpu parameters + +| Name | Description | Value | +| -------------------- | ------------------------------------------ | ----------- | +| `gpu.enabled` | Flag to enable Tfy GPU Operator | `true` | +| `gpu.clusterType` | Cluster type for Tfy GPU Operator | `civoTalos` | +| `gpu.valuesOverride` | Config override from default config values | `{}` | + +### truefoundry parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------- | +| `truefoundry.enabled` | Flag to enable TrueFoundry | `false` | +| `truefoundry.devMode.enabled` | Flag to enable TrueFoundry Dev mode | `false` | +| `truefoundry.valuesOverride` | Config override from default config values | `{}` | + +### truefoundryBootstrap parameters + +| Name | Description | Value | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------ | +| `truefoundry.truefoundryBootstrap.enabled` | Flag to enable bootstrap job to prep cluster for truefoundry installation | `true` | + +### Truefoundry virtual service parameters + +| Name | Description | Value | +| ------------------------------------- | -------------------------------------------------- | ------- | +| `truefoundry.virtualservice.enabled` | Flag to enable virtualservice | `false` | +| `truefoundry.virtualservice.hosts` | Hosts for truefoundry virtualservice | `[]` | +| `truefoundry.virtualservice.gateways` | Istio gateways to be configured for virtualservice | `[]` | + +### database. Can be left empty if using the dev mode parameters + +| Name | Description | Value | +| -------------------------------------------- | ---------------------------------------------------------- | ----- | +| `truefoundry.database.host` | Hostname of the database | `""` | +| `truefoundry.database.name` | Name of the database | `""` | +| `truefoundry.database.username` | Username of the database | `""` | +| `truefoundry.database.password` | Password of the database | `""` | +| `truefoundry.tfyApiKey` | API Key for TrueFoundry | `""` | +| `truefoundry.truefoundryImagePullConfigJSON` | Json config for authenticating to the TrueFoundry registry | `""` | + +### loki parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `loki.enabled` | Flag to enable Loki | `true` | +| `loki.valuesOverride` | Config override from default config values | `{}` | + +### istio parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `istio.enabled` | Flag to enable Istio | `true` | +| `istio.enabled` | Flag to enable Istio Base | `true` | +| `istio.base.valuesOverride` | Config override from default config values | `{}` | +| `istio.gateway.valuesOverride` | Config override from default config values | `{}` | + +### istio discovery parameters + +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------- | ---------------------- | +| `istio.discovery.hub` | Hub for the istio image | `gcr.io/istio-release` | +| `istio.discovery.tag` | Tag for the istio image | `1.21.1-distroless` | +| `istio.discovery.valuesOverride` | Config override from default config values | `{}` | +| `istio.tfyGateway.httpsRedirect` | Flag to enable HTTPS redirect for Istio Gateway | `true` | + +### keda parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `keda.enabled` | Flag to enable Keda | `true` | +| `keda.valuesOverride` | Config override from default config values | `{}` | + +### kubecost parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------ | ------ | +| `kubecost.enabled` | Flag to enable Kubecost | `true` | +| `kubecost.valuesOverride` | Config override from default config values | `{}` | + +### prometheus parameters + +| Name | Description | Value | +| --------------------------- | ------------------------------------------ | ------ | +| `prometheus.enabled` | Flag to enable Prometheus | `true` | +| `prometheus.valuesOverride` | Config override from default config values | `{}` | + +### grafana parameters + +| Name | Description | Value | +| ------------------------ | ------------------------------------------ | ------- | +| `grafana.enabled` | Flag to enable Grafana | `false` | +| `grafana.valuesOverride` | Config override from default config values | `{}` | + +### tfyAgent parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `tfyAgent.enabled` | Flag to enable Tfy Agent | `true` | +| `tfyAgent.clusterToken` | cluster token | `""` | +| `tfyAgent.valuesOverride` | Config override from default config values | `{}` | +| `tfyAgent.clusterTokenSecret` | Secret name for cluster token | `""` | + +### elasti parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------- | +| `elasti.enabled` | Flag to enable Elasti | `false` | +| `elasti.valuesOverride` | Config override from default config values | `{}` | + +### jspolicy parameters + +| Name | Description | Value | +| -------------------------------- | -------------------------------------------------------- | ------- | +| `jspolicy.enabled` | Flag to enable jspolicy. No policy is applied by default | `false` | +| `jspolicy.enabled` | Flag to enable jspolicy | `false` | +| `jspolicy.valuesOverride` | Config override from default config values | `{}` | +| `jspolicy.config.valuesOverride` | Config override from default config values | `{}` | diff --git a/charts/tfy-k8s-gcp-gke-standard-inframold/README.md b/charts/tfy-k8s-gcp-gke-standard-inframold/README.md index 913a391cb..500df1c4e 100644 --- a/charts/tfy-k8s-gcp-gke-standard-inframold/README.md +++ b/charts/tfy-k8s-gcp-gke-standard-inframold/README.md @@ -2,3 +2,177 @@ Inframold, the superchart that configure your cluster on gcp for truefoundry. ## Parameters + +### Global Parameters + +| Name | Description | Value | +| ----------------- | ---------------------------------------- | ----- | +| `tenantName` | Parameters for tenantName | `""` | +| `controlPlaneURL` | Parameters for controlPlaneURL | `""` | +| `clusterName` | Name of the cluster | `""` | +| `tolerations` | Tolerations for the all chart components | `[]` | +| `affinity` | Affinity for the all chart components | `{}` | + +### argocd parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------ | +| `argocd.enabled` | Flag to enable ArgoCD | `true` | +| `argocd.valuesOverride` | Config override from default config values | `{}` | + +### argoWorkflows parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `argoWorkflows.enabled` | Flag to enable Argo Workflows | `true` | +| `argoWorkflows.valuesOverride` | Config override from default config values | `{}` | + +### argoRollouts parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `argoRollouts.enabled` | Flag to enable Argo Rollouts | `true` | +| `argoRollouts.valuesOverride` | Config override from default config values | `{}` | + +### notebookController parameters + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | ------------------ | +| `notebookController.enabled` | Flag to enable Notebook Controller | `false` | +| `notebookController.defaultStorageClass` | Default storage class for Notebook Controller | `""` | +| `notebookController.notebookBaseDomainUrl` | Base domain URL for Notebook Controller | `` | +| `notebookController.valuesOverride` | Config override from default config values | `{}` | + +### certManager parameters + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------ | ------- | +| `certManager.enabled` | Flag to enable Cert Manager | `false` | +| `certManager.valuesOverride` | Config override from default config values | `{}` | + +### metricsServer parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------- | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.valuesOverride` | Config override from default config values | `{}` | + +### gpu parameters + +| Name | Description | Value | +| -------------------- | ------------------------------------------ | ---------------- | +| `gpu.enabled` | Flag to enable Tfy GPU Operator | `true` | +| `gpu.clusterType` | Cluster type for Tfy GPU Operator | `gcpGkeStandard` | +| `gpu.valuesOverride` | Config override from default config values | `{}` | + +### truefoundry parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------- | +| `truefoundry.enabled` | Flag to enable TrueFoundry | `false` | +| `truefoundry.devMode.enabled` | Flag to enable TrueFoundry Dev mode | `false` | +| `truefoundry.valuesOverride` | Config override from default config values | `{}` | + +### truefoundryBootstrap parameters + +| Name | Description | Value | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------ | +| `truefoundry.truefoundryBootstrap.enabled` | Flag to enable bootstrap job to prep cluster for truefoundry installation | `true` | + +### Truefoundry virtual service parameters + +| Name | Description | Value | +| ------------------------------------- | -------------------------------------------------- | ------- | +| `truefoundry.virtualservice.enabled` | Flag to enable virtualservice | `false` | +| `truefoundry.virtualservice.hosts` | Hosts for truefoundry virtualservice | `[]` | +| `truefoundry.virtualservice.gateways` | Istio gateways to be configured for virtualservice | `[]` | + +### database. Can be left empty if using the dev mode parameters + +| Name | Description | Value | +| -------------------------------------------- | ---------------------------------------------------------- | ----- | +| `truefoundry.database.host` | Hostname of the database | `""` | +| `truefoundry.database.name` | Name of the database | `""` | +| `truefoundry.database.username` | Username of the database | `""` | +| `truefoundry.database.password` | Password of the database | `""` | +| `truefoundry.tfyApiKey` | API Key for TrueFoundry | `""` | +| `truefoundry.truefoundryImagePullConfigJSON` | Json config for authenticating to the TrueFoundry registry | `""` | + +### loki parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `loki.enabled` | Flag to enable Loki | `true` | +| `loki.valuesOverride` | Config override from default config values | `{}` | + +### istio parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `istio.enabled` | Flag to enable Istio | `true` | +| `istio.enabled` | Flag to enable Istio Base | `true` | +| `istio.base.valuesOverride` | Config override from default config values | `{}` | +| `istio.gateway.valuesOverride` | Config override from default config values | `{}` | + +### istio discovery parameters + +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------- | ---------------------- | +| `istio.discovery.hub` | Hub for the istio image | `gcr.io/istio-release` | +| `istio.discovery.tag` | Tag for the istio image | `1.21.1-distroless` | +| `istio.discovery.valuesOverride` | Config override from default config values | `{}` | +| `istio.tfyGateway.httpsRedirect` | Flag to enable HTTPS redirect for Istio Gateway | `true` | + +### keda parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `keda.enabled` | Flag to enable Keda | `true` | +| `keda.valuesOverride` | Config override from default config values | `{}` | + +### kubecost parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------ | ------ | +| `kubecost.enabled` | Flag to enable Kubecost | `true` | +| `kubecost.valuesOverride` | Config override from default config values | `{}` | + +### prometheus parameters + +| Name | Description | Value | +| --------------------------- | ------------------------------------------ | ------ | +| `prometheus.enabled` | Flag to enable Prometheus | `true` | +| `prometheus.valuesOverride` | Config override from default config values | `{}` | + +### grafana parameters + +| Name | Description | Value | +| ------------------------ | ------------------------------------------ | ------- | +| `grafana.enabled` | Flag to enable Grafana | `false` | +| `grafana.valuesOverride` | Config override from default config values | `{}` | + +### tfyAgent parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `tfyAgent.enabled` | Flag to enable Tfy Agent | `true` | +| `tfyAgent.clusterToken` | cluster token | `""` | +| `tfyAgent.valuesOverride` | Config override from default config values | `{}` | +| `tfyAgent.clusterTokenSecret` | Secret name for cluster token | `""` | + +### elasti parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------- | +| `elasti.enabled` | Flag to enable Elasti | `false` | +| `elasti.valuesOverride` | Config override from default config values | `{}` | + +### jspolicy parameters + +| Name | Description | Value | +| -------------------------------- | -------------------------------------------------------- | ------- | +| `jspolicy.enabled` | Flag to enable jspolicy. No policy is applied by default | `false` | +| `jspolicy.enabled` | Flag to enable jspolicy | `false` | +| `jspolicy.valuesOverride` | Config override from default config values | `{}` | +| `jspolicy.config.valuesOverride` | Config override from default config values | `{}` | diff --git a/charts/tfy-k8s-generic-inframold/README.md b/charts/tfy-k8s-generic-inframold/README.md index a84a4c908..681d769ab 100644 --- a/charts/tfy-k8s-generic-inframold/README.md +++ b/charts/tfy-k8s-generic-inframold/README.md @@ -2,3 +2,177 @@ Inframold, the superchart that configure your cluster on generic for truefoundry. ## Parameters + +### Global Parameters + +| Name | Description | Value | +| ----------------- | ---------------------------------------- | ----- | +| `tenantName` | Parameters for tenantName | `""` | +| `controlPlaneURL` | Parameters for controlPlaneURL | `""` | +| `clusterName` | Name of the cluster | `""` | +| `tolerations` | Tolerations for the all chart components | `[]` | +| `affinity` | Affinity for the all chart components | `{}` | + +### argocd parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------ | +| `argocd.enabled` | Flag to enable ArgoCD | `true` | +| `argocd.valuesOverride` | Config override from default config values | `{}` | + +### argoWorkflows parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `argoWorkflows.enabled` | Flag to enable Argo Workflows | `true` | +| `argoWorkflows.valuesOverride` | Config override from default config values | `{}` | + +### argoRollouts parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `argoRollouts.enabled` | Flag to enable Argo Rollouts | `true` | +| `argoRollouts.valuesOverride` | Config override from default config values | `{}` | + +### notebookController parameters + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | ------------------ | +| `notebookController.enabled` | Flag to enable Notebook Controller | `false` | +| `notebookController.defaultStorageClass` | Default storage class for Notebook Controller | `""` | +| `notebookController.notebookBaseDomainUrl` | Base domain URL for Notebook Controller | `` | +| `notebookController.valuesOverride` | Config override from default config values | `{}` | + +### certManager parameters + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------ | ------- | +| `certManager.enabled` | Flag to enable Cert Manager | `false` | +| `certManager.valuesOverride` | Config override from default config values | `{}` | + +### metricsServer parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------- | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.enabled` | Flag to enable Metrics Server | `false` | +| `metricsServer.valuesOverride` | Config override from default config values | `{}` | + +### gpu parameters + +| Name | Description | Value | +| -------------------- | ------------------------------------------ | --------- | +| `gpu.enabled` | Flag to enable Tfy GPU Operator | `true` | +| `gpu.clusterType` | Cluster type for Tfy GPU Operator | `generic` | +| `gpu.valuesOverride` | Config override from default config values | `{}` | + +### truefoundry parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------- | +| `truefoundry.enabled` | Flag to enable TrueFoundry | `false` | +| `truefoundry.devMode.enabled` | Flag to enable TrueFoundry Dev mode | `false` | +| `truefoundry.valuesOverride` | Config override from default config values | `{}` | + +### truefoundryBootstrap parameters + +| Name | Description | Value | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------ | +| `truefoundry.truefoundryBootstrap.enabled` | Flag to enable bootstrap job to prep cluster for truefoundry installation | `true` | + +### Truefoundry virtual service parameters + +| Name | Description | Value | +| ------------------------------------- | -------------------------------------------------- | ------- | +| `truefoundry.virtualservice.enabled` | Flag to enable virtualservice | `false` | +| `truefoundry.virtualservice.hosts` | Hosts for truefoundry virtualservice | `[]` | +| `truefoundry.virtualservice.gateways` | Istio gateways to be configured for virtualservice | `[]` | + +### database. Can be left empty if using the dev mode parameters + +| Name | Description | Value | +| -------------------------------------------- | ---------------------------------------------------------- | ----- | +| `truefoundry.database.host` | Hostname of the database | `""` | +| `truefoundry.database.name` | Name of the database | `""` | +| `truefoundry.database.username` | Username of the database | `""` | +| `truefoundry.database.password` | Password of the database | `""` | +| `truefoundry.tfyApiKey` | API Key for TrueFoundry | `""` | +| `truefoundry.truefoundryImagePullConfigJSON` | Json config for authenticating to the TrueFoundry registry | `""` | + +### loki parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `loki.enabled` | Flag to enable Loki | `true` | +| `loki.valuesOverride` | Config override from default config values | `{}` | + +### istio parameters + +| Name | Description | Value | +| ------------------------------ | ------------------------------------------ | ------ | +| `istio.enabled` | Flag to enable Istio | `true` | +| `istio.enabled` | Flag to enable Istio Base | `true` | +| `istio.base.valuesOverride` | Config override from default config values | `{}` | +| `istio.gateway.valuesOverride` | Config override from default config values | `{}` | + +### istio discovery parameters + +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------- | ---------------------- | +| `istio.discovery.hub` | Hub for the istio image | `gcr.io/istio-release` | +| `istio.discovery.tag` | Tag for the istio image | `1.21.1-distroless` | +| `istio.discovery.valuesOverride` | Config override from default config values | `{}` | +| `istio.tfyGateway.httpsRedirect` | Flag to enable HTTPS redirect for Istio Gateway | `false` | + +### keda parameters + +| Name | Description | Value | +| --------------------- | ------------------------------------------ | ------ | +| `keda.enabled` | Flag to enable Keda | `true` | +| `keda.valuesOverride` | Config override from default config values | `{}` | + +### kubecost parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------ | ------ | +| `kubecost.enabled` | Flag to enable Kubecost | `true` | +| `kubecost.valuesOverride` | Config override from default config values | `{}` | + +### prometheus parameters + +| Name | Description | Value | +| --------------------------- | ------------------------------------------ | ------ | +| `prometheus.enabled` | Flag to enable Prometheus | `true` | +| `prometheus.valuesOverride` | Config override from default config values | `{}` | + +### grafana parameters + +| Name | Description | Value | +| ------------------------ | ------------------------------------------ | ------- | +| `grafana.enabled` | Flag to enable Grafana | `false` | +| `grafana.valuesOverride` | Config override from default config values | `{}` | + +### tfyAgent parameters + +| Name | Description | Value | +| ----------------------------- | ------------------------------------------ | ------ | +| `tfyAgent.enabled` | Flag to enable Tfy Agent | `true` | +| `tfyAgent.clusterToken` | cluster token | `""` | +| `tfyAgent.valuesOverride` | Config override from default config values | `{}` | +| `tfyAgent.clusterTokenSecret` | Secret name for cluster token | `""` | + +### elasti parameters + +| Name | Description | Value | +| ----------------------- | ------------------------------------------ | ------- | +| `elasti.enabled` | Flag to enable Elasti | `false` | +| `elasti.valuesOverride` | Config override from default config values | `{}` | + +### jspolicy parameters + +| Name | Description | Value | +| -------------------------------- | -------------------------------------------------------- | ------- | +| `jspolicy.enabled` | Flag to enable jspolicy. No policy is applied by default | `false` | +| `jspolicy.enabled` | Flag to enable jspolicy | `false` | +| `jspolicy.valuesOverride` | Config override from default config values | `{}` | +| `jspolicy.config.valuesOverride` | Config override from default config values | `{}` |