docs: added example output and fixed run cmd (#35)

* docs: added example output and fixed run cmd

* fix: update lockfile

Author: very-doge-wow

.github/workflows/lintmarkdown.yml

@@ -12,4 +12,4 @@ jobs:
       uses: docker://avtodev/markdown-lint:v1
       with:
         args: './*.md'
-        ignore: './test/output.md ./test/custom-template-keywords.md'
+        ignore: './test/output.md ./test/custom-template-keywords.md ./EXAMPLE_OUTPUT.md'

EXAMPLE_OUTPUT.md

@@ -0,0 +1,87 @@
+# kibana
+![Version: 8.4.1](https://img.shields.io/badge/Version-8.4.1-informational?style=flat-square) ![Version: 8.4.1](https://img.shields.io/badge/appVersion-8.4.1-informational?style=flat-square) ![Version: v1](https://img.shields.io/badge/apiVersion-v1-informational?style=flat-square) ![Type: unknown](https://img.shields.io/badge/Type-unknown-informational?style=flat-square) 
+
+## Description
+Official Elastic helm chart for Kibana
+
+## Dependencies
+This chart depends on the following subcharts.
+
+*No dependencies found.*
+
+## Templates
+The following templates will be deployed.
+
+| Path |
+|---| 
+| configmap-helm-scripts.yaml |
+| configmap.yaml |
+| deployment.yaml |
+| ingress.yaml |
+| job.yaml |
+| service.yaml |
+
+
+### Objects
+The aforementioned templates will deploy the following objects.
+
+| Kind | From template |
+|---|---| 
+| ConfigMap | configmap-helm-scripts.yaml |
+| ConfigMap | configmap.yaml |
+| Deployment | deployment.yaml |
+| Ingress | ingress.yaml |
+| Job | job.yaml |
+| Service | service.yaml |
+
+
+## Values
+The following values can/will be used for deployments.
+
+| Name | Description | Default | Example |
+|---|---|---|---| 
+| elasticsearchHosts |  | <pre>elasticsearchHosts: https://elasticsearch-master:9200<br></pre> |  |
+| elasticsearchCertificateSecret |  | <pre>elasticsearchCertificateSecret: elasticsearch-master-certs<br></pre> |  |
+| elasticsearchCertificateAuthoritiesFile |  | <pre>elasticsearchCertificateAuthoritiesFile: ca.crt<br></pre> |  |
+| elasticsearchCredentialSecret |  | <pre>elasticsearchCredentialSecret: elasticsearch-master-credentials<br></pre> |  |
+| replicas |  | <pre>replicas: 1<br></pre> |  |
+| extraEnvs |  | <pre>extraEnvs:<br>- name: NODE_OPTIONS<br>  value: --max-old-space-size=1800<br></pre> |  |
+| envFrom |  | <pre>envFrom: []<br></pre> |  |
+| secretMounts |  | <pre>secretMounts: []<br></pre> |  |
+| hostAliases |  | <pre>hostAliases: []<br></pre> |  |
+| image |  | <pre>image: docker.elastic.co/kibana/kibana<br></pre> |  |
+| imageTag |  | <pre>imageTag: 8.4.1<br></pre> |  |
+| imagePullPolicy |  | <pre>imagePullPolicy: IfNotPresent<br></pre> |  |
+| labels |  | <pre>labels: {}<br></pre> |  |
+| annotations |  | <pre>annotations: {}<br></pre> |  |
+| podAnnotations |  | <pre>podAnnotations: {}<br></pre> |  |
+| resources |  | <pre>resources:<br>  limits:<br>    cpu: 1000m<br>    memory: 2Gi<br>  requests:<br>    cpu: 1000m<br>    memory: 2Gi<br></pre> |  |
+| protocol |  | <pre>protocol: http<br></pre> |  |
+| serverHost |  | <pre>serverHost: 0.0.0.0<br></pre> |  |
+| healthCheckPath |  | <pre>healthCheckPath: /app/kibana<br></pre> |  |
+| kibanaConfig |  | <pre>kibanaConfig: {}<br></pre> |  |
+| podSecurityContext |  | <pre>podSecurityContext:<br>  fsGroup: 1000<br></pre> |  |
+| securityContext |  | <pre>securityContext:<br>  capabilities:<br>    drop:<br>    - ALL<br>  runAsNonRoot: true<br>  runAsUser: 1000<br></pre> |  |
+| serviceAccount |  | <pre>serviceAccount: ''<br></pre> |  |
+| automountToken |  | <pre>automountToken: true<br></pre> |  |
+| priorityClassName |  | <pre>priorityClassName: ''<br></pre> |  |
+| httpPort |  | <pre>httpPort: 5601<br></pre> |  |
+| extraVolumes |  | <pre>extraVolumes: []<br></pre> |  |
+| extraVolumeMounts |  | <pre>extraVolumeMounts: []<br></pre> |  |
+| extraContainers |  | <pre>extraContainers: []<br></pre> |  |
+| extraInitContainers |  | <pre>extraInitContainers: []<br></pre> |  |
+| updateStrategy |  | <pre>updateStrategy:<br>  type: Recreate<br></pre> |  |
+| service |  | <pre>service:<br>  annotations: {}<br>  httpPortName: http<br>  labels: {}<br>  loadBalancerIP: ''<br>  loadBalancerSourceRanges: []<br>  nodePort: ''<br>  port: 5601<br>  type: ClusterIP<br></pre> |  |
+| ingress |  | <pre>ingress:<br>  annotations: {}<br>  className: nginx<br>  enabled: false<br>  hosts:<br>  - host: kibana-example.local<br>    paths:<br>    - path: /<br>  pathtype: ImplementationSpecific<br></pre> |  |
+| readinessProbe |  | <pre>readinessProbe:<br>  failureThreshold: 3<br>  initialDelaySeconds: 10<br>  periodSeconds: 10<br>  successThreshold: 3<br>  timeoutSeconds: 5<br></pre> |  |
+| imagePullSecrets |  | <pre>imagePullSecrets: []<br></pre> |  |
+| nodeSelector |  | <pre>nodeSelector: {}<br></pre> |  |
+| tolerations |  | <pre>tolerations: []<br></pre> |  |
+| affinity |  | <pre>affinity: {}<br></pre> |  |
+| nameOverride |  | <pre>nameOverride: ''<br></pre> |  |
+| fullnameOverride |  | <pre>fullnameOverride: ''<br></pre> |  |
+| lifecycle |  | <pre>lifecycle: {}<br></pre> |  |
+
+
+*Automatic helm documentation generated using [very-doge-wow/stella](https://github.com/very-doge-wow/stella).*
+

Pipfile.lock

@@ -12,6 +12,13 @@ It supports simple templating, so custom templates for output can be used as
 well. Will read metadata such as `Chart.yaml`, `values.yaml` or the present
 templates and generate a Markdown or HTML documentation from that data.
 
+## Example
+
+For an example output when running `stella` for the
+[kibana](https://github.com/elastic/helm-charts/tree/main/kibana) helm chart,
+follow [this](https://github.com/very-doge-wow/stella/blob/main/EXAMPLE_OUTPUT.md)
+link.
+
 ## Usage
 
 ### Docker Image
@@ -21,7 +28,7 @@ Using the [OCI image](https://hub.docker.com/r/suchdogewow/stella):
 <!-- markdownlint-disable MD013 -->
 ```shell
 docker pull suchdogewow/stella:latest
-docker run -v ${full_path_to_host_chart_dir}:/tmp/chart stella -hcp /tmp/chart -o /tmp/chart/output.md [OPTIONS]
+docker run -v ${full_path_to_host_chart_dir}:/tmp/chart suchdogewow/stella -hcp /tmp/chart -o /tmp/chart/output.md [OPTIONS]
 ```
 <!-- markdownlint-enable MD013 -->