Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sspreitzer/helm-ara
ARA Records Ansible Helm Chart
https://github.com/sspreitzer/helm-ara
Last synced: 7 days ago
JSON representation
ARA Records Ansible Helm Chart
- Host: GitHub
- URL: https://github.com/sspreitzer/helm-ara
- Owner: sspreitzer
- License: mit
- Created: 2022-05-14T08:32:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-23T11:21:37.000Z (over 2 years ago)
- Last Synced: 2024-08-02T15:10:47.791Z (3 months ago)
- Language: Smarty
- Size: 48.8 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ARA Records Ansible Helm Chart
ARA is a Python and Django based visualization for Ansible Playbook runs. An Ansible callback plugin records the playbook results to an ARA instance via http(s). This work is a publicly hosted Open Source Helm Chart of ARA.
Overview of [ARA Records Ansible](https://ara.recordsansible.org).
## TL;DR
```shell
helm repo add spreitzer https://registry.spreitzer.ch/chartrepo/helm
helm install my-release spreitzer/ara
```
## Introduction
This Helm Chart deploys an ARA api instance. ARA api is the server component of the ARA software. It will serve Ansible playbook run reports and hosts in a user friendly web interface, as well as the api which the client part uses to submit reports.
The ARA api is neither secured or open for submitting reports. You will have to configure the ARA api for authentication. Please see the [ARA documentation](https://ara.readthedocs.io/en/latest/api-configuration.html). The ARA api may be secured by disabling authentication in ARA api and providing authentication over HTTPS via [ingress annotations](#ingress-parameters).
ARA api supports a multitude of database backends configurable via the aforementioned environment variables. This Helm Chart may in future support high availability and incorporate an easy configuration. However at the moment you will have to configure high availability and scalability via replicas, deployment strategy, persistence and the deployment environment variables by yourself.
## Contributing
Please contribute here:
* [Issues](https://git.spreitzer.ch/helm/ara/-/issues)
* [Merge Requests](https://git.spreitzer.ch/helm/ara/-/merge_requests)
Under the conditions of merit:
* You create it (eg. features), you lead it
* You break it, you fix it
* Be kind and benevolent, but prefer contribution over harmony
With your contribution you agree that your work is published under the MIT license of this project. See [LICENSE](/LICENSE).
## Prerequisites
* Kubernetes
* Helm
* Storage in Kubernetes
## Parameters
### Common Parameters
| Name | Description | Value |
| ---------------------------------- | ---------------------------- | -------------------------- |
| `replicas` | Amount of deployment replias | `1` |
| `extraEnv` | Extra environment variables | `{}` |
| `deploymentStrategy.type` | Deployment type | `"RollingUpdate"` |
| `deploymentStrategy.rollingUpdate` | RollingUpdate parameters | `{}` |
| `image.repo` | Image repository | `"recordsansible/ara-api"` |
| `image.tag` | Image tag | `"latest"` |
| `service.type` | Type of kubernetes service | `"ClusterIP"` |
Please find ARA api environment variables and behavior documented [here](https://ara.readthedocs.io/en/latest/api-configuration.html).
Example
```yaml
replicas: 1
deploymentStrategy:
type: Recreate
extraEnv:
ARA_ALLOWED_HOSTS: "['localhost', '::1', '127.0.0.1', 'ara.example.com', 'ara-web.example.com']"
ARA_EXTERNAL_AUTH: 'True'
ARA_READ_LOGIN_REQUIRED: 'False'
ARA_WRITE_LOGIN_REQUIRED: 'False'
```
### Ingress Parameters
| Name | Description | Value |
| --------------------- | ----------------------------------- | --------------------- |
| `ingress.enabled` | Switch to enable/disable an ingress | `false` |
| `ingress.annotations` | Ingress annotations map | `{}` |
| `ingress.tls` | Switch to enable/disable TLS/SSL | `false` |
| `ingress.tlsSecret` | Name of secret of tls certificate | `"ara-tls"` |
| `ingress.hosts` | List of FQDN for the ingress | `["ara.example.com"]` |
Example
```yaml
ingress:
annotations:
cert-manager.io/cluster-issuer: letsencrypt
nginx.ingress.kubernetes.io/auth-type: basic
nginx.ingress.kubernetes.io/auth-realm: "ARA Records Ansible"
nginx.ingress.kubernetes.io/auth-secret: ara-htpasswd
enabled: true
tls: true
hosts:
- ara.example.com
```
### Persistence Parameters
| Name | Description | Value |
| -------------------------- | ------------------------------------ | ------------------- |
| `persistence.enabled` | Switch to enable/disable persistence | `false` |
| `persistence.accessModes` | Volume access modes | `["ReadWriteOnce"]` |
| `persistence.size` | Size of volume | `"8Gi"` |
| `persistence.storageClass` | StorageClass of volume | `""` |
Example
```yaml
persistence:
enabled: true
accessModes:
- ReadWriteOnce
storageClass: default
```
### OAuth2 Proxy Parameters
Refer to:
* https://oauth2-proxy.github.io/oauth2-proxy/docs/
* https://github.com/oauth2-proxy/manifests/tree/main/helm/oauth2-proxy
* https://github.com/oauth2-proxy/manifests/blob/main/helm/oauth2-proxy/values.yaml
Example
```yaml
oauth2proxy:
enabled: true
redis:
enabled: true
sessionStorage:
type: redis
config:
clientID: xxx
clientSecret: xxx
cookieSecret: xxx
extraArgs:
upstream: http://ara-ara:8000
provider: keycloak-oidc
redirect-url: https://ara-web.example.com/oauth2/callback
oidc-issuer-url: https:///auth/realms/
allowed-group: ara
ingress:
enabled: true
annotations:
cert-manager.io/cluster-issuer: letsencrypt
hosts:
- ara-web.example.com
tls:
- secretName: oauth2-proxy-tls
hosts:
- ara-web.example.com
```
## Configuration and Installation Details
tbd.
## Persistence
tbd.
## Upgrading
tbd.
## License
Free and Open Source, MIT license, See [LICENSE](/LICENSE).
## Credits
* The [bitnami/charts/mariadb/README.md](https://github.com/bitnami/charts/blob/master/bitnami/mariadb/README.md) documentation served as inspiration for this documentation
## Authors
* [Sascha Spreitzer](https://spreitzer.ch)