Skip to content

Commit b26d2df

Browse files
rfelberrfelber
committed
Added operator docs
Signed-off-by: Robert Seedorff <Robert.Seedorff@iteratec.com>
1 parent b017ae6 commit b26d2df

File tree

7 files changed

+148
-1
lines changed

7 files changed

+148
-1
lines changed

‎.github/workflows/helm-docs.yaml‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ jobs:
2323
passphrase: ${{ secrets.GPG_COMMITS_PASSPHRASE }}
2424
git-user-signingkey: true
2525
git-commit-gpgsign: true
26-
commit_options: '--signoff'
2726

2827
- name: Download Helm Docs
2928
run: |
@@ -107,6 +106,18 @@ jobs:
107106
)
108107
done
109108
109+
- name: Generate Core Docs
110+
run: |
111+
# Start in the operator folder
112+
cd operator
113+
if [ -d "docs" ]; then
114+
echo "Docs Folder found at: operator/docs"
115+
./../helm-docs/helm-docs --template-files=./../.helm-docs/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=./../.helm-docs/README.DockerHub-Core.md.gotmpl --output-file=docs/README.DockerHub-Core.md
116+
./../helm-docs/helm-docs --template-files=./../.helm-docs/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=./../.helm-docs/README.ArtifactHub.md.gotmpl --output-file=docs/README.ArtifactHub.md
117+
else
118+
echo "Ignoring Docs creation process for Chart $dir, because no `docs` folder found at: operator/docs"
119+
fi
120+
110121
- name: Remove Helm Docs Files
111122
run: |
112123
# Remove helm-docs download to ensure they don't get commited back
@@ -115,3 +126,6 @@ jobs:
115126
with:
116127
commit_message: Updating Helm Docs
117128
commit_user_email: securecodebox@iteratec.com
129+
# Optional. Used by `git-commit`.
130+
# See https://git-scm.com/docs/git-commit#_options
131+
commit_options: '--signoff'

‎.helm-docs/README.DockerHub-Core.md.gotmpl‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{{- /*
2+
SPDX-FileCopyrightText: 2020 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/ -}}
6+
{{ template "extra.hintSection" . }}
7+
8+
{{ template "extra.badgesSection" . }}
9+
10+
{{ template "extra.secureCodeBoxAboutSection" . }}
11+
12+
{{ template "extra.dockerDeploymentSection" . }}
13+
14+
## How to use this image
15+
This `core` image is intended to work in combination with the OWASP secureCodeBox. For more informations details please take a look at the documentation page: {{ template "chart.homepage" . }}.
16+
17+
```bash
18+
docker pull securecodebox/{{ template "chart.name" . }}
19+
```
20+
21+
{{ template "extra.chartAboutSection" . }}
22+
23+
{{ template "extra.communitySection" . }}
24+
25+
{{ template "extra.dockerLicenseSection" . }}
26+
27+
{{ template "extra.generalLinksSection" . }}
28+
{{ template "extra.scannerLinksSection" . }}

‎operator/.dockerignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
!**/*.go
88
!**/*.mod
99
!**/*.sum
10+
docs/

‎operator/.helm-docs.gotmpl‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{{- /*
2+
SPDX-FileCopyrightText: 2020 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/ -}}
6+
7+
{{- define "extra.docsSection" -}}
8+
---
9+
title: "secreCodeBox Operator"
10+
category: "core"
11+
type: "Operator"
12+
state: "released"
13+
appVersion: "{{ template "chart.appVersion" . }}"
14+
usecase: "secureCodeBox Operator is the core componente."
15+
---
16+
17+
![operator logo](https://docs.securecodebox.io/img/Logo_Color.svg)
18+
19+
{{- end }}
20+
21+
{{- define "extra.dockerDeploymentSection" -}}
22+
## Supported Tags
23+
- `latest` (represents the latest stable release build)
24+
- tagged releases, e.g. `{{ template "chart.version" . }}`
25+
{{- end }}
26+
27+
{{- define "extra.chartAboutSection" -}}
28+
## What is secureCodeBox Operator?
29+
The secureCodeBox operator is running on Kubernetes and is the core component of the complete secureCodeBox stack, responsible for managing all scans and resources.
30+
31+
**Homepage:** <https://docs.securecodebox.io/docs/getting-started/installation>
32+
33+
{{- end }}
34+
35+
{{- define "extra.scannerConfigurationSection" -}}{{- end }}
36+
37+
{{- define "extra.chartConfigurationSection" -}}
38+
## Deployment
39+
40+
The secureCodeBox Operator can be deployed via helm:
41+
42+
```bash
43+
# Add the secureCodeBox Helm Repo
44+
helm repo add secureCodeBox https://charts.securecodebox.io
45+
# Create a new namespace for the secureCodeBox Operator
46+
kubectl create namespace securecodebox-system
47+
# Install the Operator & CRDs
48+
helm install securecodebox-operator secureCodeBox/operator
49+
```
50+
{{- end }}
51+
52+
{{- define "extra.scannerLinksSection" -}}
53+
{{- end }}

‎operator/.helmignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,4 @@ main.go
4040
Makefile
4141
PROJECT
4242
README.md.gotmpl
43+
docs/

‎operator/docs/README.ArtifactHub.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2020 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
<!--
7+
.: IMPORTANT! :.
8+
--------------------------
9+
This file is generated automaticaly with `helm-docs` based on the following template files:
10+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
11+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
12+
13+
Please be aware of that and apply your changes only within those template files instead of this file.
14+
Otherwise your changes will be reverted/overriden automaticaly due to the build process `./.github/workflows/helm-docs.yaml`
15+
--------------------------
16+
-->
17+
18+
<p align="center">
19+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
20+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"></a>
21+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"></a>
22+
<a href="https://artifacthub.io/packages/search?repo=seccurecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/seccurecodebox"></a>
23+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"></a>
24+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"></a>
25+
</p>

‎operator/docs/README.DockerHub-Core.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2020 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
<!--
7+
.: IMPORTANT! :.
8+
--------------------------
9+
This file is generated automaticaly with `helm-docs` based on the following template files:
10+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
11+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
12+
13+
Please be aware of that and apply your changes only within those template files instead of this file.
14+
Otherwise your changes will be reverted/overriden automaticaly due to the build process `./.github/workflows/helm-docs.yaml`
15+
--------------------------
16+
-->
17+
18+
<p align="center">
19+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
20+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"></a>
21+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"></a>
22+
<a href="https://artifacthub.io/packages/search?repo=seccurecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/seccurecodebox"></a>
23+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"></a>
24+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"></a>
25+
</p>

0 commit comments

Comments
 (0)