Skip to content

docs(cf-common): upd values #2

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

Merged
merged 3 commits into from
Feb 17, 2023
Merged

docs(cf-common): upd values #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a2eedd
upd readme
mikhail-klimko Feb 17, 2023
b1273c7
bump version
mikhail-klimko Feb 17, 2023
d874804
upd docs
mikhail-klimko Feb 17, 2023
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
2 changes: 1 addition & 1 deletion charts/cf-common/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: v0.0.0
description: Codefresh library chart
name: cf-common
version: 0.0.1
version: 0.0.2
type: library
keywords:
- codefresh
Expand Down
11 changes: 5 additions & 6 deletions charts/cf-common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Codefresh library chart

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)

## Installing the Chart

Expand All @@ -18,7 +18,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
# Chart.yaml
dependencies:
- name: cf-common
version: 0.0.1
version: 0.0.2
repository: https://chartmuseum.codefresh.io/cf-common
```

Expand All @@ -43,13 +43,12 @@ dependencies:
| configMaps.config.data | object | `{}` | ConfigMap data content. |
| configMaps.config.enabled | bool | `false` | Enable the configMap |
| configMaps.config.labels | object | `{}` | Add additional labels to the configMap |
| container | object | `{"args":[],"command":[],"containerSecurityContext":{},"env":{},"envFrom":[],"extraEnvVars":null,"image":{"pullPolicy":null,"registry":null,"repository":null,"tag":null},"lifecycle":{},"probes":{"liveness":{"enabled":false,"exec":{"command":[]},"httpGet":{"path":null,"port":null},"spec":{"failureThreshold":null,"initialDelaySeconds":null,"periodSeconds":null,"successThreshold":null,"timeoutSeconds":null},"type":null},"readiness":{"enabled":false},"startup":{"enabled":false}},"resources":{"limits":{},"requests":{}},"volumeMounts":{}}` | Main Container parameters |
| container | object | `{"args":[],"command":[],"containerSecurityContext":{},"env":{},"envFrom":[],"image":{"pullPolicy":null,"registry":null,"repository":null,"tag":null},"lifecycle":{},"probes":{"liveness":{"enabled":false,"exec":{"command":[]},"httpGet":{"path":null,"port":null},"spec":{"failureThreshold":null,"initialDelaySeconds":null,"periodSeconds":null,"successThreshold":null,"timeoutSeconds":null},"type":null},"readiness":{"enabled":false},"startup":{"enabled":false}},"resources":{"limits":{},"requests":{}},"volumeMounts":{}}` | Main Container parameters |
| container.args | list | `[]` | Override args for the container |
| container.command | list | `[]` | Override commands for the container |
| container.containerSecurityContext | object | `{}` | Set security context for container |
| container.env | object | `{}` | Set environments variables |
| container.env | object | `{}` | Set environments variables. Helm template supported. |
| container.envFrom | list | `[]` | Set Secrets or ConfigMaps loaded as environment variables. |
| container.extraEnvVars | string | `nil` | Set additional environment variables. Helm template supported. Passed through `tpl`, should be configured as string |
| container.image | object | `{"pullPolicy":null,"registry":null,"repository":null,"tag":null}` | Image parameters |
| container.image.pullPolicy | string | `nil` | Set image pull policy (`Always`, `Never`, `IfNotPresent`) |
| container.image.registry | string | `nil` | Set image registry |
Expand Down Expand Up @@ -102,7 +101,7 @@ dependencies:
| secrets.secret.annotation | object | `{}` | Add additional annotations to the secret |
| secrets.secret.enabled | bool | `false` | Enable the secret |
| secrets.secret.labels | object | `{}` | Add additional labels to the secret |
| secrets.secret.stringData | object | `{}` | Secret data content. Plain text |
| secrets.secret.stringData | object | `{}` | Secret data content. Plain text (not base64). Helm template supported. Passed through `tpl`, should be configured as string |
| secrets.secret.type | string | `"Opaque"` | Set secret type (`Opaque`/`kubernetes.io/tls`) |
| services | object | `{"main":{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}}` | Configure services fo the chart. Additional services can be added by adding a dictionary key similar to the 'main' service. |
| services.main | object | `{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}` | Service name |
Expand Down
28 changes: 11 additions & 17 deletions charts/cf-common/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,12 @@ container:
# -- Override args for the container
args: []

# -- Set environments variables
# -- Set environments variables. Helm template supported.
env: {}
# E.g.
# env:
# ALICE: BOB
# FOO: "{{ .Valies.config.foo }}"
# -- Set Secrets or ConfigMaps loaded as environment variables.
envFrom: []
# E.g.
Expand All @@ -71,19 +75,6 @@ container:
# - configMapRef:
# name: my-config-map

# -- Set additional environment variables.
# Helm template supported. Passed through `tpl`, should be configured as string
extraEnvVars:
# E.g.
# extraEnvVars: |
# - name: ALICE
# valueFrom:
# secretKeyRef:
# name: "{{ .Release.Name }}-{{ $.Values.global.somekey }}"
# key: alice
# - name: FOO
# value: "{{ .Values.config.foo }}"

# -- Set volume mounts for container
volumeMounts: {}

Expand Down Expand Up @@ -185,14 +176,17 @@ secrets:
annotation: {}
# -- Set secret type (`Opaque`/`kubernetes.io/tls`)
type: Opaque
# -- Secret data content. Plain text
# -- Secret data content. Plain text (not base64). Helm template supported. Passed through `tpl`, should be configured as string
stringData: {}
# foo: bar
# Helm template supported. Passed through `tpl`, should be configured as string
# stringData:
# FOO: BAR
# E.g.
# stringData: |
# FOO: "{{ .Values.global.foo }}"
# BAR: "{{ .Values.global.bar }}"
# {{- if .Values.global.something }}
# ALICE: value
# {{- end }}
data: {}
# -- Secret data content. Should be passed as base64 encoded text
# Helm template NOT supported.
Expand Down