Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): document parameters in README #13

Merged
merged 1 commit into from
Apr 27, 2022
Merged

docs(readme): document parameters in README #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions cryostat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,84 @@
# cryostat-helm
Helm Chart for Cryostat

## Parameters

### Cryostat Container

| Name | Description | Value |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `core` | Configuration for the core Cryostat application | |
| `core.image.repository` | Repository for the main Cryostat container image | `quay.io/cryostat/cryostat` |
| `core.image.pullPolicy` | Image pull policy for the main Cryostat container image | `Always` |
| `core.image.tag` | Tag for the main Cryostat container image | `2.1.0-SNAPSHOT` |
| `core.service.type` | Type of Service to create for the Cryostat application | `ClusterIP` |
| `core.service.httpPort` | Port number to expose on the Service for Cryostat's HTTP server | `8181` |
| `core.service.jmxPort` | Port number to expose on the Service for remote JMX connections to Cryostat | `9091` |
| `core.ingress.enabled` | Whether to create an Ingress object for the Cryostat service | `false` |
| `core.ingress.className` | Ingress class name for the Cryostat application Ingress | `""` |
| `core.ingress.annotations` | Annotations to apply to the Cryostat application Ingress | `{}` |
| `core.ingress.hosts` | Hosts to create rules for in the Cryostat application Ingress. See: [IngressSpec](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-v1/#IngressSpec) | `[]` |
| `core.ingress.tls` | TLS configuration for the Cryostat application Ingress. See: [IngressSpec](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-v1/#IngressSpec) | `[]` |
| `core.route.enabled` | Whether to create a Route object for the Cryostat service. Available only on OpenShift | `false` |
| `core.route.tls.enabled` | Whether to secure the Cryostat application Route with TLS. See: [TLSConfig](https://docs.openshift.com/container-platform/4.10/rest_api/network_apis/route-route-openshift-io-v1.html#spec-tls) | `true` |
| `core.route.tls.termination` | Type of TLS termination to use for the Cryostat application Route. One of: `edge`, `passthrough`, `reencrypt` | `edge` |
| `core.route.tls.insecureEdgeTerminationPolicy` | Specify how to handle insecure traffic for the Cryostat application Route. One of: `Allow`, `Disable`, `Redirect` | `Redirect` |
| `core.route.tls.key` | Custom private key to use when securing the Cryostat application Route | `""` |
| `core.route.tls.certificate` | Custom certificate to use when securing the Cryostat application Route | `""` |
| `core.route.tls.caCertificate` | Custom CA certificate to use, if needed to complete the certificate chain, when securing the Cryostat application Route | `""` |
| `core.route.tls.destinationCACertificate` | Provides the contents of the CA certificate of the final destination when using reencrypt termination for the Cryostat application Route | `""` |
| `core.resources` | Resource requests/limits for the Cryostat container. See: [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | `{}` |
| `core.securityContext` | Security Context for the Cryostat container. See: [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1) | `{}` |


### Grafana Container

| Name | Description | Value |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `grafana` | Configuration for the customized Grafana instance for Cryostat | |
| `grafana.image.repository` | Repository for the Grafana container image | `quay.io/cryostat/cryostat-grafana-dashboard` |
| `grafana.image.pullPolicy` | Image pull policy for the Grafana container image | `IfNotPresent` |
| `grafana.image.tag` | Tag for the Grafana container image | `2.0.0` |
| `grafana.service.type` | Type of Service to create for Grafana | `ClusterIP` |
| `grafana.service.port` | Port number to expose on the Service for Grafana's HTTP server | `3000` |
| `grafana.ingress.enabled` | Whether to create an Ingress object for the Grafana service | `false` |
| `grafana.ingress.className` | Ingress class name for the Grafana Ingress | `""` |
| `grafana.ingress.annotations` | Annotations to apply to the Grafana Ingress | `{}` |
| `grafana.ingress.hosts` | Hosts to create rules for in the Grafana Ingress. See: [IngressSpec](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-v1/#IngressSpec) | `[]` |
| `grafana.ingress.tls` | TLS configuration for the Grafana Ingress. See: [IngressSpec](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-v1/#IngressSpec) | `[]` |
| `grafana.route.enabled` | Whether to create a Route object for the Grafana service. Available only on OpenShift | `false` |
| `grafana.route.tls.enabled` | Whether to secure the Grafana Route with TLS. See: [TLSConfig](https://docs.openshift.com/container-platform/4.10/rest_api/network_apis/route-route-openshift-io-v1.html#spec-tls) | `true` |
| `grafana.route.tls.termination` | Type of TLS termination to use for the Grafana Route. One of: `edge`, `passthrough`, `reencrypt` | `edge` |
| `grafana.route.tls.insecureEdgeTerminationPolicy` | Specify how to handle insecure traffic for the Grafana Route. One of: `Allow`, `Disable`, `Redirect` | `Redirect` |
| `grafana.route.tls.key` | Custom private key to use when securing the Grafana Route | `""` |
| `grafana.route.tls.certificate` | Custom certificate to use when securing the Grafana Route | `""` |
| `grafana.route.tls.caCertificate` | Custom CA certificate to use, if needed to complete the certificate chain, when securing the Grafana Route | `""` |
| `grafana.route.tls.destinationCACertificate` | Provides the contents of the CA certificate of the final destination when using reencrypt termination for the Grafana Route | `""` |
| `grafana.resources` | Resource requests/limits for the Grafana container. See: [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | `{}` |
| `grafana.securityContext` | Security Context for the Grafana container. See: [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1) | `{}` |


### JFR Data Source Container

| Name | Description | Value |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `datasource` | Configuration for the JFR Data Source component, which translates recording events into a format consumable by Grafana | |
| `datasource.image.repository` | Repository for the JFR Data Source container image | `quay.io/cryostat/jfr-datasource` |
| `datasource.image.pullPolicy` | Image pull policy for the JFR Data Source container image | `IfNotPresent` |
| `datasource.image.tag` | Tag for the JFR Data Source container image | `2.0.0` |
| `datasource.resources` | Resource requests/limits for the JFR Data Source container. See: [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | `{}` |
| `datasource.securityContext` | Security Context for the JFR Data Source container. See: [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1) | `{}` |
| `imagePullSecrets` | Image pull secrets to be used for the Cryostat deployment | `[]` |
| `nameOverride` | Overrides the name of this Chart | `""` |
| `fullnameOverride` | Overrides the fully qualified application name of "<release name>-<chart name>" | `""` |
| `rbac.create` | Specifies whether RBAC resources should be created | `true` |
| `serviceAccount.create` | Specifies whether a service account should be created | `true` |
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
| `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | `""` |
| `podAnnotations` | Annotations to be applied to the Cryostat Pod | `{}` |
| `podSecurityContext` | Security Context for the Cryostat Pod. See: [PodSecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) | `{}` |
| `nodeSelector` | Node Selector for the Cryostat Pod. See: [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` |
| `tolerations` | Tolerations for the Cryostat Pod. See: [Tolerations](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` |
| `affinity` | Affinity for the Cryostat Pod. See: [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` |


Loading