Skip to content

Commit

Permalink
add generated readme
Browse files Browse the repository at this point in the history
Signed-off-by: Griffin <prakritimandal611@gmail.com>
  • Loading branch information
prakrit55 committed Oct 23, 2023
1 parent 80f36e1 commit 47704cc
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions klt-cert-manager/chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ resource.

| Name | Description | Value |
| --------------------------- | ---------------------------------------------- | ----- |
| `replicas` | customize number of replicas | `1` |
| `nodeSelector` | specify custom node selectors for cert manager | `{}` |
| `replicas` | customize number of replicas | `1` |
| `tolerations` | customize tolerations for cert manager | `[]` |
| `topologySpreadConstraints` | add topology constraints for cert manager | `[]` |

Expand All @@ -20,11 +20,11 @@ resource.
| Name | Description | Value |
| -------------------------- | ------------------------------------------------------------------------- | ------------------------------------ |
| `containerSecurityContext` | Sets security context for the cert manager | |
| `env.labelSelectorKey` | specify the label selector to find resources to generate certificates for | `keptn.sh/inject-cert` |
| `env.labelSelectorValue` | specify the value for the label selector | `true` |
| `image.repository` | specify repo for manager image | `ghcr.io/keptn/certificate-operator` |
| `image.tag` | select tag for manager container | `v1.1.0` |
| `imagePullPolicy` | select image pull policy for manager container | `Always` |
| `env.labelSelectorKey` | specify the label selector to find resources to generate certificates for | `keptn.sh/inject-cert` |
| `env.labelSelectorValue` | specify the value for the label selector | `true` |
| `livenessProbe` | custom RBAC proxy liveness probe | |
| `readinessProbe` | custom manager readiness probe | |
| `resources` | custom limits and requests for manager container | |
Expand All @@ -33,5 +33,5 @@ resource.

| Name | Description | Value |
| ------------------------- | -------------------------------------- | --------------- |
| `kubernetesClusterDomain` | overrides domain.local | `cluster.local` |
| `imagePullSecrets` | global value for image registry secret | `[]` |
| `kubernetesClusterDomain` | overrides domain.local | `cluster.local` |
22 changes: 11 additions & 11 deletions lifecycle-operator/chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,11 @@ and application health checks
| `lifecycleOperatorConfig.leaderElection.resourceName` | define LeaderElectionID | `6b866dd9.keptn.sh` |
| `lifecycleOperatorConfig.metrics.bindAddress` | MetricsBindAddress is the TCP address that the controller should bind to for serving prometheus metrics. It can be set to "0" to disable the metrics serving. | `127.0.0.1:8080` |
| `lifecycleOperatorConfig.webhook.port` | setup port for the lifecycle operator admission webhook | `9443` |
| `lifecycleOperator.replicas` | customize number of installed lifecycle operator replicas | `1` |
| `lifecycleOperatorMetricsService` | Adjust settings here to change the k8s service for scraping Prometheus metrics | |
| `lifecycleWebhookService` | Mutating Webhook Configurations for lifecycle Operator | |
| `lifecycleWebhookService.ports[0].port` | | `443` |
| `lifecycleWebhookService.ports[0].protocol` | | `TCP` |
| `lifecycleWebhookService.ports[0].targetPort` | | `9443` |
| `lifecycleWebhookService.type` | | `ClusterIP` |
| `lifecycleOperator.nodeSelector` | add custom nodes selector to lifecycle operator | `{}` |
| `lifecycleOperator.tolerations` | add custom tolerations to lifecycle operator | `[]` |
| `lifecycleOperator.topologySpreadConstraints` | add custom topology constraints to lifecycle operator | `[]` |

### Keptn Lifecycle Operator controller

Expand All @@ -38,6 +33,7 @@ and application health checks
| `lifecycleOperator.containerSecurityContext.runAsNonRoot` | | `true` |
| `lifecycleOperator.containerSecurityContext.runAsUser` | | `65532` |
| `lifecycleOperator.containerSecurityContext.seccompProfile.type` | | `RuntimeDefault` |
| `lifecycleOperator.env.functionRunnerImage` | specify image for deno task runtime | `ghcr.io/keptn/deno-runtime:v1.0.1` |
| `lifecycleOperator.env.keptnAppControllerLogLevel` | sets the log level of Keptn App Controller | `0` |
| `lifecycleOperator.env.keptnAppCreationRequestControllerLogLevel` | sets the log level of Keptn App Creation Request Controller | `0` |
| `lifecycleOperator.env.keptnAppVersionControllerLogLevel` | sets the log level of Keptn AppVersion Controller | `0` |
Expand All @@ -49,28 +45,34 @@ and application health checks
| `lifecycleOperator.env.keptnWorkloadInstanceControllerLogLevel` | Deprecated: Use keptnWorkloadVersionControllerLogLevel instead. Sets the log level of Keptn WorkloadVersion Controller | `0` |
| `lifecycleOperator.env.optionsControllerLogLevel` | sets the log level of Keptn Options Controller | `0` |
| `lifecycleOperator.env.otelCollectorUrl` | Sets the URL for the open telemetry collector | `otel-collector:4317` |
| `lifecycleOperator.env.functionRunnerImage` | specify image for deno task runtime | `ghcr.io/keptn/deno-runtime:v1.0.1` |
| `lifecycleOperator.env.pythonRunnerImage` | specify image for python task runtime | `ghcr.io/keptn/python-runtime:v1.0.0` |
| `lifecycleOperator.image.repository` | specify registry for manager image | `ghcr.io/keptn/lifecycle-operator` |
| `lifecycleOperator.image.tag` | select tag for manager image | `v0.8.2` |
| `lifecycleOperator.imagePullPolicy` | specify pull policy for manager image | `Always` |
| `lifecycleOperator.livenessProbe` | custom livenessprobe for manager container | |
| `lifecycleOperator.readinessProbe` | custom readinessprobe for manager container | |
| `lifecycleOperator.resources` | specify limits and requests for manager container | |
| `lifecycleOperator.nodeSelector` | add custom nodes selector to lifecycle operator | `{}` |
| `lifecycleOperator.replicas` | customize number of installed lifecycle operator replicas | `1` |
| `lifecycleOperator.tolerations` | add custom tolerations to lifecycle operator | `[]` |
| `lifecycleOperator.topologySpreadConstraints` | add custom topology constraints to lifecycle operator | `[]` |
| `lifecycleOperatorMetricsService` | Adjust settings here to change the k8s service for scraping Prometheus metrics | |

### Global

| Name | Description | Value |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| `kubernetesClusterDomain` | overrides domain.local | `cluster.local` |
| `imagePullSecrets` | global value for image registry secret | `[]` |
| `kubernetesClusterDomain` | overrides domain.local | `cluster.local` |
| `schedulingGatesEnabled` | enables the scheduling gates in lifecycle-operator. This feature is available in alpha version from K8s 1.27 or 1.26 enabling the alpha version | `false` |
| `allowedNamespaces` | specifies the allowed namespaces for the lifecycle orchestration functionality | `[]` |

### Keptn Scheduler

| Name | Description | Value |
| ------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------- |
| `scheduler.nodeSelector` | adds node selectors for scheduler | `{}` |
| `scheduler.replicas` | modifies replicas | `1` |
| `scheduler.containerSecurityContext` | Sets security context | |
| `scheduler.env.otelCollectorUrl` | sets url for open telemetry collector | `otel-collector:4317` |
| `scheduler.image.repository` | set image repository for scheduler | `ghcr.io/keptn/scheduler` |
Expand All @@ -79,10 +81,8 @@ and application health checks
| `scheduler.livenessProbe` | customizable liveness probe for the scheduler | |
| `scheduler.readinessProbe` | customizable readiness probe for the scheduler | |
| `scheduler.resources` | sets cpu and memory resurces/limits for scheduler | |
| `scheduler.topologySpreadConstraints` | add topology constraints for scheduler | `[]` |
| `schedulerConfig.profiles[0].schedulerName` | changes scheduler name | `keptn-scheduler` |
| `schedulerConfig.leaderElection.leaderElect` | enables leader election for multiple replicas of the scheduler | `false` |
| `schedulerConfig.profiles[0].plugins.permit.enabled[0].name` | enables permit plugin | `KLCPermit` |
| `schedulerConfig.profiles[0].schedulerName` | changes scheduler name | `keptn-scheduler` |
| `scheduler.nodeSelector` | adds node selectors for scheduler | `{}` |
| `scheduler.replicas` | modifies replicas | `1` |
| `scheduler.tolerations` | adds tolerations for scheduler | `[]` |
| `scheduler.topologySpreadConstraints` | add topology constraints for scheduler | `[]` |
Loading

0 comments on commit 47704cc

Please sign in to comment.