srx/fab-city-os-core-chart
1
0
Fork 0
mirror of https://gitlab.fabcity.hamburg/software/fab-city-os-core-chart.git synced 2024-09-19 20:08:53 +02:00
Code Packages Projects Releases Activity

seperated documentation

Browse source
This commit is contained in:
Sebastian Wendel 2022-06-22 17:39:04 +02:00
parent 887eef5179
commit 01bd2762e7
No known key found for this signature in database
GPG key ID: 1422B7DF78144640
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -45,13 +45,13 @@ k3d cluster create --config k3d-fcos-dev.yaml
Validate chart rendering
```sh
helm install --dry-run fcos-core .
helm install --dry-run fcoscore .
```
You can install and test the Helm chart by running:
```bash
helm install fcos-core .
helm install fcoscore .
```
Watch all resources to be fully applied to the cluster:
@ -63,19 +63,19 @@ watch -n 1 kubectl get all --all-namespaces
An easy way to access your FabCityOS instance and test that it is up and running is by using port-forwarding. This can be achieved by running:
```bash
kubectl port-forward --namespace default svc/fcos-core 7700:7700
kubectl port-forward --namespace default svc/fcoscore 7700:7700
```
Finally, to uninstall the chart, run:
```bash
helm uninstall fcos-core
helm uninstall fcoscore
```
Validate chart rendering
```sh
helm install --dry-run fcos-core .
helm install --dry-run fcoscore .
```
### Tests and Linter <!-- omit in toc -->
@ -87,11 +87,11 @@ Each PR should pass the linter to be accepted.
helm lint .
```
Each PR should also check if the generated file `manifests/fcos-core.yaml` is updated with the new modifications.
Each PR should also check if the generated file `manifests/fcoscore.yaml` is updated with the new modifications.
You can generated the manifest with the command line:
```bash
helm template fcos-core . | grep -v 'helm.sh/chart:\|app.kubernetes.io/managed-by:' > manifests/FabCityOS.yaml
helm template fcoscore . | grep -v 'helm.sh/chart:\|app.kubernetes.io/managed-by:' > manifests/FabCityOS.yaml
```
Or just by comment the PR:
@ -145,7 +145,7 @@ _[Read more about this]()._
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration]().
⚠️ Every PR that is merged to `main` introducing changes to the Helm Chart needs to modify the file [`charts/fcos-core/Chart.yaml`](charts/fcos-core/Chart.yaml), by increasing the version of the chart accordingly.
⚠️ Every PR that is merged to `main` introducing changes to the Helm Chart needs to modify the file [`charts/fcoscore/Chart.yaml`](charts/fcoscore/Chart.yaml), by increasing the version of the chart accordingly.
Every PR that is merged to `main` triggers the automated release process, as specified at [``](). A GitHub Action will be triggered and publish a new release on the GitHub repository [releases](). This will enable users to start using the new version of the chart immediately after publishing.

8
README.md
View file

@ -1,5 +1,5 @@
<p align="center">
<svg width="35" height="30" viewBox="0 0 35 30" fill="none" xmlns="http://www.w3.org/2000/svg"><title>INTERFACER</title><path d="M35.625 0H9.375V7.5H35.625V0Z" fill="currentColor"></path><path d="M3.75 7.5C5.82107 7.5 7.5 5.82107 7.5 3.75C7.5 1.67893 5.82107 0 3.75 0C1.67893 0 0 1.67893 0 3.75C0 5.82107 1.67893 7.5 3.75 7.5Z" fill="currentColor"></path><path d="M13.125 30C15.1961 30 16.875 28.3211 16.875 26.25C16.875 24.1789 15.1961 22.5 13.125 22.5C11.0539 22.5 9.375 24.1789 9.375 26.25C9.375 28.3211 11.0539 30 13.125 30Z" fill="currentColor"></path><path d="M7.5 22.5H0V30H7.5V22.5Z" fill="currentColor"></path><path d="M4.37251 11.25C1.95751 11.25 0 12.93 0 15C0 17.07 1.95751 18.75 4.37251 18.75H26.25V11.25H4.37251Z" fill="currentColor"></path></svg>
<img src="https://www.fabcity.hamburg/wp-content/uploads/2021/04/cropped-Fab_City_Hamburg@4x-192x192.png" alt="FabCity Hamburg" width="192" height="192" />
</p>
<h1 align="center">FabCityOS Core Kubernetes Helm Chart</h1>
@ -54,7 +54,7 @@ Helm CLI is a Command Line Interface which will automate chart management and in
#### Install and run FabCityOS Core <!-- omit in toc -->
```bash
helm install fcos-core .
helm install fcoscore .
```
#### Uninstalling the Chart <!-- omit in toc -->
@ -62,7 +62,7 @@ helm install fcos-core .
To uninstall/delete the FabCityOS Core deployment:
```bash
helm uninstall fcos-core
helm uninstall fcoscore
```
## 🤖 Compatibility with FabCityOS Core
@ -70,7 +70,7 @@ helm uninstall fcos-core
We recommend that the Helm chart version is aligned to the version of the product you want to deploy. This will ensure that you are using a chart version that has been tested against the corresponding production version.
This will also ensure that the documentation and examples for the chart will work with the version of the product, you are installing.
For example, if you want to deploy an FCOS-Core `0.1.0` cluster, use the corresponding `0.1.0` [tag][fcos-core-010].
For example, if you want to deploy an fcoscore `0.1.0` cluster, use the corresponding `0.1.0` [tag][fcoscore-010].
The `master` version of these charts is intended to support the latest pre-release versions of our products, and therefore may or may not work with current released versions.