Skip to content

Commit

Permalink
Commit released Helm Chart and docs for TrueCharts
Browse files Browse the repository at this point in the history
Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
  • Loading branch information
truecharts-admin committed Mar 6, 2022
1 parent e51afeb commit 8b31de2
Show file tree
Hide file tree
Showing 12 changed files with 401 additions and 77 deletions.
9 changes: 9 additions & 0 deletions charts/core/docker-compose/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Changelog<br>


<a name="docker-compose-1.0.1"></a>
### [docker-compose-1.0.1](https://github.com/truecharts/apps/compare/docker-compose-1.0.0...docker-compose-1.0.1) (2022-03-06)

#### Chore

* move docker-compose to core after testing



<a name="docker-compose-1.0.0"></a>
### [docker-compose-1.0.0](https://github.com/truecharts/apps/compare/docker-compose-0.0.8...docker-compose-1.0.0) (2022-03-03)

Expand Down
2 changes: 1 addition & 1 deletion charts/core/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not gu

## Source Code

* <https://github.com/Jackett/Jackett>
* <https://hub.docker.com/_/docker>

## Requirements

Expand Down
1 change: 0 additions & 1 deletion charts/incubator/openhab/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@
#### Add

* add openHAB ([#2038](https://github.com/truecharts/apps/issues/2038))

19 changes: 9 additions & 10 deletions charts/incubator/openhab/security.md

Large diffs are not rendered by default.

92 changes: 92 additions & 0 deletions docs/apps/core/docker-compose/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Changelog<br>


<a name="docker-compose-1.0.1"></a>
### [docker-compose-1.0.1](https://github.com/truecharts/apps/compare/docker-compose-1.0.0...docker-compose-1.0.1) (2022-03-06)

#### Chore

* move docker-compose to core after testing



<a name="docker-compose-1.0.0"></a>
### [docker-compose-1.0.0](https://github.com/truecharts/apps/compare/docker-compose-0.0.8...docker-compose-1.0.0) (2022-03-03)

#### Chore

* remove fixed env from questions.yaml
* update helm general major helm releases ([#2021](https://github.com/truecharts/apps/issues/2021))

#### Fix

* BREAKING CHANGE Move some env-vars outside of env section ([#2010](https://github.com/truecharts/apps/issues/2010))



<a name="docker-compose-0.0.8"></a>
### [docker-compose-0.0.8](https://github.com/truecharts/apps/compare/docker-compose-0.0.7...docker-compose-0.0.8) (2022-03-02)

#### Chore

* update helm general non-major helm releases ([#1999](https://github.com/truecharts/apps/issues/1999))



<a name="docker-compose-0.0.7"></a>
### [docker-compose-0.0.7](https://github.com/truecharts/apps/compare/docker-compose-0.0.6...docker-compose-0.0.7) (2022-02-25)

#### Chore

* update common to test host-compose-disable



<a name="docker-compose-0.0.6"></a>
### [docker-compose-0.0.6](https://github.com/truecharts/apps/compare/docker-compose-0.0.5...docker-compose-0.0.6) (2022-02-24)

#### Fix

* fix autoloading of docker-compose file



<a name="docker-compose-0.0.5"></a>
### [docker-compose-0.0.5](https://github.com/truecharts/apps/compare/docker-compose-0.0.4...docker-compose-0.0.5) (2022-02-24)

#### Feat

* wait for docker to be running before loading docker-compose file ([#1960](https://github.com/truecharts/apps/issues/1960))



<a name="docker-compose-0.0.4"></a>
### [docker-compose-0.0.4](https://github.com/truecharts/apps/compare/docker-compose-0.0.3...docker-compose-0.0.4) (2022-02-24)



<a name="docker-compose-0.0.3"></a>
### [docker-compose-0.0.3](https://github.com/truecharts/apps/compare/docker-compose-0.0.2...docker-compose-0.0.3) (2022-02-24)

#### Feat

* Add autoloading for compose file ([#1958](https://github.com/truecharts/apps/issues/1958))



<a name="docker-compose-0.0.2"></a>
### [docker-compose-0.0.2](https://github.com/truecharts/apps/compare/docker-compose-0.0.1...docker-compose-0.0.2) (2022-02-24)

#### Chore

* rename `web_portal` to `open` ([#1957](https://github.com/truecharts/apps/issues/1957))
* Update adding tc catalog ([#1956](https://github.com/truecharts/apps/issues/1956))



<a name="docker-compose-0.0.1"></a>
### docker-compose-0.0.1 (2022-02-24)

#### Feat

* add a dedicated App for using Docker-Compose ([#1954](https://github.com/truecharts/apps/issues/1954))
8 changes: 8 additions & 0 deletions docs/apps/core/docker-compose/CONFIG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Configuration Options

##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/

##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.
69 changes: 69 additions & 0 deletions docs/apps/core/docker-compose/helm-values.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Default Helm-Values

TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.

Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.replicas | int | `1` | Number of desired pods |
| controller.revisionHistoryLimit | int | `3` | ReplicaSet revision history limit |
| controller.rollingUpdate.partition | string | `nil` | Set statefulset RollingUpdate partition |
| controller.rollingUpdate.surge | string | `nil` | Set deployment RollingUpdate max surge |
| controller.rollingUpdate.unavailable | int | `1` | Set deployment RollingUpdate max unavailable |
| controller.strategy | string | `"RollingUpdate"` | Set the controller upgrade strategy For Deployments, valid values are Recreate (default) and RollingUpdate. For StatefulSets, valid values are OnDelete and RollingUpdate (default). DaemonSets ignore this. |
| controller.type | string | `"statefulset"` | Set the controller type. Valid options are deployment, daemonset or statefulset |
| env.COMPOSE_FILE | string | `""` | |
| env.DOCKER_TLS_CERTDIR | string | `"/certs"` | |
| hostNetwork | bool | `true` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/docker-in-docker"` | |
| image.tag | string | `"v20.10.12@sha256:06af3ce416ac5d30697178378f164a9a9494bc5dcb182b0f441ed9f5087a5fe7"` | |
| lifecycle.postStart.exec.command[0] | string | `"/bin/bash"` | |
| lifecycle.postStart.exec.command[1] | string | `"-c"` | |
| lifecycle.postStart.exec.command[2] | string | `"if [ \"${COMPOSE_FILE}\" ]; then\ncounter=0;\nwhile ! docker info > /dev/null 2>&1 && [[ ${counter} -lt 10 ]]; do\necho \"docker not running yet. Waiting...\" >> /proc/1/fd/1;\nsleep 5;\ncounter=$((counter+1));\ndone\ndocker-compose -f \"${COMPOSE_FILE}\" up -d && echo \"Loading COMPOSE_FILE at location ${COMPOSE_FILE}\" >> /proc/1/fd/1;\nelse\necho \"COMPOSE_FILE not set, not auto-loading compose-file\" >> /proc/1/fd/1;\nfi\n"` | |
| persistence.cluster.enabled | bool | `true` | |
| persistence.cluster.hostPath | string | `"/cluster"` | |
| persistence.cluster.hostPathType | string | `""` | |
| persistence.cluster.mountPath | string | `"/cluster"` | |
| persistence.cluster.readOnly | bool | `false` | |
| persistence.cluster.type | string | `"hostPath"` | |
| persistence.docker-certs-ca.enabled | bool | `true` | |
| persistence.docker-certs-ca.mountPath | string | `"/config"` | |
| persistence.mnt.enabled | bool | `true` | |
| persistence.mnt.hostPath | string | `"/mnt"` | |
| persistence.mnt.hostPathType | string | `""` | |
| persistence.mnt.mountPath | string | `"/mnt"` | |
| persistence.mnt.readOnly | bool | `false` | |
| persistence.mnt.type | string | `"hostPath"` | |
| persistence.root.enabled | bool | `true` | |
| persistence.root.hostPath | string | `"/root"` | |
| persistence.root.hostPathType | string | `""` | |
| persistence.root.mountPath | string | `"/root"` | |
| persistence.root.readOnly | bool | `false` | |
| persistence.root.type | string | `"hostPath"` | |
| persistence.varrun.enabled | bool | `false` | |
| podSecurityContext.fsGroup | int | `0` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| probes.liveness.spec.initialDelaySeconds | int | `30` | |
| probes.readiness.spec.initialDelaySeconds | int | `30` | |
| probes.startup.spec.initialDelaySeconds | int | `30` | |
| securityContext.allowPrivilegeEscalation | bool | `true` | |
| securityContext.privileged | bool | `true` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.enabled | bool | `true` | |
| service.main.ports.main.port | int | `2376` | |
| service.main.ports.main.type | string | `"HTTPS"` | |
| volumeClaimTemplates.docker-certs-client.enabled | bool | `true` | |
| volumeClaimTemplates.docker-certs-client.mountPath | string | `"/certs/client"` | |
| volumeClaimTemplates.docker.enabled | bool | `true` | |
| volumeClaimTemplates.docker.mountPath | string | `"/var/lib/docker"` | |

All Rights Reserved - The TrueCharts Project
37 changes: 37 additions & 0 deletions docs/apps/core/docker-compose/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Introduction

Dedicated App for using Docker-Compose on TrueNAS SCALE

TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**

## Source Code

* <https://hub.docker.com/_/docker>

## Requirements

Kubernetes: `>=1.16.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org | common | 9.0.0 |

## Installing the Chart

To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).

## Uninstalling the Chart

To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).

## Support

- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project
Loading

0 comments on commit 8b31de2

Please sign in to comment.