github.com/replicatedhq/ship@v0.55.0/integration/init/kibana/expected/.ship/upstream/README.md (about) 1 # kibana 2 3 [kibana](https://github.com/elastic/kibana) is your window into the Elastic Stack. Specifically, it's an open source (Apache Licensed), browser-based analytics and search dashboard for Elasticsearch. 4 5 ## TL;DR; 6 7 ```console 8 $ helm install stable/kibana 9 ``` 10 11 ## Introduction 12 13 This chart bootstraps a kibana deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. 14 15 ## Installing the Chart 16 17 To install the chart with the release name `my-release`: 18 19 ```console 20 $ helm install stable/kibana --name my-release 21 ``` 22 23 The command deploys kibana on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. 24 25 NOTE : We notice that lower resource constraints given to the chart + plugins are likely not going to work well. 26 27 ## Uninstalling the Chart 28 29 To uninstall/delete the `my-release` deployment: 30 31 ```console 32 $ helm delete my-release 33 ``` 34 35 The command removes all the Kubernetes components associated with the chart and deletes the release. 36 37 ## Configuration 38 39 The following table lists the configurable parameters of the kibana chart and their default values. 40 41 | Parameter | Description | Default | 42 |-----------------------------------------------|--------------------------------------------|----------------------------------------| 43 | `affinity` | node/pod affinities | None | 44 | `env` | Environment variables to configure Kibana | `{}` | 45 | `files` | Kibana configuration files | None | 46 | `livenessProbe.enabled` | livenessProbe to be enabled? | `false` | 47 | `livenessProbe.initialDelaySeconds` | number of seconds | 30 | 48 | `livenessProbe.timeoutSeconds` | number of seconds | 10 | 49 | `image.pullPolicy` | Image pull policy | `IfNotPresent` | 50 | `image.repository` | Image repository | `docker.elastic.co/kibana/kibana-oss` | 51 | `image.tag` | Image tag | `6.5.4` | 52 | `image.pullSecrets` | Specify image pull secrets | `nil` | 53 | `commandline.args` | add additional commandline args | `nil` | 54 | `ingress.enabled` | Enables Ingress | `false` | 55 | `ingress.annotations` | Ingress annotations | None: | 56 | `ingress.hosts` | Ingress accepted hostnames | None: | 57 | `ingress.tls` | Ingress TLS configuration | None: | 58 | `nodeSelector` | node labels for pod assignment | `{}` | 59 | `podAnnotations` | annotations to add to each pod | `{}` | 60 | `replicaCount` | desired number of pods | `1` | 61 | `revisionHistoryLimit` | revisionHistoryLimit | `3` | 62 | `serviceAccountName` | DEPRECATED: use serviceAccount.name | `nil` | 63 | `serviceAccount.create` | create a serviceAccount to run the pod | `false` | 64 | `serviceAccount.name` | name of the serviceAccount to create | `kibana.fullname` | 65 | `authProxyEnabled` | enables authproxy. Create container in extracontainers | `false` | 66 | `extraContainers` | Sidecar containers to add to the kibana pod| `{}` | 67 | `resources` | pod resource requests & limits | `{}` | 68 | `priorityClassName` | priorityClassName | `nil` | 69 | `service.externalPort` | external port for the service | `443` | 70 | `service.internalPort` | internal port for the service | `4180` | 71 | `service.authProxyPort` | port to use when using sidecar authProxy | None: | 72 | `service.externalIPs` | external IP addresses | None: | 73 | `service.loadBalancerIP` | Load Balancer IP address | None: | 74 | `service.loadBalancerSourceRanges` | Limit load balancer source IPs to list of CIDRs (where available)) | `[]` | 75 | `service.nodePort` | NodePort value if service.type is NodePort | None: | 76 | `service.type` | type of service | `ClusterIP` | 77 | `service.annotations` | Kubernetes service annotations | None: | 78 | `service.labels` | Kubernetes service labels | None: | 79 | `tolerations` | List of node taints to tolerate | `[]` | 80 | `dashboardImport.timeout` | Time in seconds waiting for Kibana to be in green overall state | `60` | 81 | `dashboardImport.xpackauth.enabled` | Enable Xpack auth | `false` | 82 | `dashboardImport.xpackauth.username` | Optional Xpack username | `myuser` | 83 | `dashboardImport.xpackauth.password` | Optional Xpack password | `mypass` | 84 | `dashboardImport.dashboards` | Dashboards | `{}` | 85 | `plugins.enabled` | Enable installation of plugins. | `false` | 86 | `plugins.reset` | Optional : Remove all installed plugins before installing all new ones | `false` | 87 | `plugins.values` | List of plugins to install. Format <pluginName,version,URL> with URLs pointing to zip files of Kibana plugins to install | None: | 88 | `persistentVolumeClaim.enabled` | Enable PVC for plugins | `false` | 89 | `persistentVolumeClaim.existingClaim` | Use your own PVC for plugins | `false` | 90 | `persistentVolumeClaim.annotations` | Add your annotations for the PVC | `{}` | 91 | `persistentVolumeClaim.accessModes` | Acces mode to the PVC | `ReadWriteOnce` | 92 | `persistentVolumeClaim.size` | Size of the PVC | `5Gi` | 93 | `persistentVolumeClaim.storageClass` | Storage class of the PVC | None: | 94 | `readinessProbe.enabled` | readinessProbe to be enabled? | `false` | 95 | `readinessProbe.initialDelaySeconds` | number of seconds | 30 | 96 | `readinessProbe.timeoutSeconds` | number of seconds | 10 | 97 | `readinessProbe.periodSeconds` | number of seconds | 10 | 98 | `readinessProbe.successThreshold` | number of successes | 5 | 99 | `securityContext.enabled` | Enable security context (should be true for PVC) | `false` | 100 | `securityContext.allowPrivilegeEscalation` | Allow privilege escalation | `false` | 101 | `securityContext.runAsUser` | User id to run in pods | `1000` | 102 | `securityContext.fsGroup` | fsGroup id to run in pods | `2000` | 103 | `extraConfigMapMounts` | Additional configmaps to be mounted | `[]` | 104 | `deployment.annotations` | Annotations for deployment | `{}` | 105 106 107 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, 108 109 * The Kibana configuration files config properties can be set through the `env` parameter too. 110 * All the files listed under this variable will overwrite any existing files by the same name in kibana config directory. 111 * Files not mentioned under this variable will remain unaffected. 112 113 ```console 114 $ helm install stable/kibana --name my-release \ 115 --set=image.tag=v0.0.2,resources.limits.cpu=200m 116 ``` 117 118 Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example : 119 120 ```console 121 $ helm install stable/kibana --name my-release -f values.yaml 122 ``` 123 124 > **Tip**: You can use the default [values.yaml](values.yaml) 125 126 ## Dasboard import 127 128 * A dashboard for dashboardImport.dashboards can be a JSON or a download url to a JSON file.