-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Latest conf. updates, yaml config and usage guide
Signed-off-by: Ljupcho Palashevski <lpalashevski@gmail.com>
- Loading branch information
1 parent
aed01c3
commit 5d5b70c
Showing
13 changed files
with
205 additions
and
164 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,11 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # Copyright Contributors to the Egeria project. | ||
| --- | ||
| # This helm chart was generated using helm create https://helm.sh/docs/helm/helm_create/ | ||
| # Only part of the resources such as deployment and service are relevant, the rest are kept as placeholder templates. | ||
| apiVersion: v2 | ||
| name: egeria-server | ||
| description: A Helm chart for Kubernetes | ||
|
|
||
| # A chart can be either an 'application' or a 'library' chart. | ||
| # | ||
| # Application charts are a collection of templates that can be packaged into versioned archives | ||
| # to be deployed. | ||
| # | ||
| # Library charts provide useful utilities or functions for the chart developer. They're included as | ||
| # a dependency of application charts to inject those utilities and functions into the rendering | ||
| # pipeline. Library charts do not define any templates and therefore cannot be deployed. | ||
| description: A Helm chart used to demonstrate Egeria stand-alone OMAG server deployment | ||
| type: application | ||
|
|
||
| # This is the chart version. This version number should be incremented each time you make changes | ||
| # to the chart and its templates, including the app version. | ||
| # Versions are expected to follow Semantic Versioning (https://semver.org/) | ||
| version: 0.1.0 | ||
|
|
||
| # This is the version number of the application being deployed. This version number should be | ||
| # incremented each time you make changes to the application. Versions are not expected to | ||
| # follow Semantic Versioning. They should reflect the version the application is using. | ||
| # It is recommended to use it with quotes. | ||
| appVersion: "4.3-SNAPSHOT" | ||
| version: 4.3-prerelease.1 | ||
| appVersion: "4.3" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
| <!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
|
||
| # Egeria OMAG Server helm chart | ||
|
|
||
| ## Description | ||
|
|
||
| The purpose of this chart is to demonstrate stand-alone OMAG server deployment for Kubernetes. | ||
| The deployment is based on Egeria main docker image. By modifying the default container entry point variable we are able to create new runtime environment similar to the platform deployment. | ||
|
|
||
| ## How it works | ||
|
|
||
| The container application is configured using standard deployment and config map resources customized by setting the values in 'app' map in [values.yaml](values.yaml) | ||
|
|
||
| ``````yaml | ||
| app: | ||
| jarPath: "/deployments/server" | ||
| jarName: "omag-server" | ||
| loaderPath: "/deployments/server/lib" | ||
| configPath: "/deployments/server/conf" | ||
| configName: "cocoMDS1.yml" | ||
| livenessProbe: "/actuator/health/livenessState" | ||
| readinessProbe: "/actuator/health/readinessState" | ||
| `````` | ||
|
|
||
| `app.jarPath` The path where the boot jar application is located inside the image. | ||
|
|
||
| `app.jarName` The name of the boot jar available on the `app.jarPath` location in the image. | ||
|
|
||
| `app.loaderPath` The spring boot application `LOADER_PATH`. This is the classpath location for Egeria connector libraries and additional third party libraries to be loaded at runtime. | ||
|
|
||
| `app.configPath` The location where configuration files will be located. Note this location is used as volume mount path inside the container. | ||
|
|
||
| `app.configName` The name of the configuration file (json or yaml) that will be loaded from `app.configPath` by the OMAG server instance on start-up. | ||
|
|
||
| `livenessProbe` and `readinessProbe` Standard kubernetes pod probes representing liveness and readiness states respectively. | ||
|
|
||
| For demo purpose, the chart contains example configuration files located in the [files](files) directory. The files placed here will be always copied as config map resources and mounted inside the container at location defined by `app.configPath`. From here, the server is trying to load the file defined by `app.configName` value. | ||
|
|
||
| For more details check out the [config.yaml](templates/config.yaml) and [deployment.yaml](templates/deployment.yaml) resources. | ||
|
|
||
|
|
||
| ## Installation steps | ||
|
|
||
| ### From helm repository | ||
|
|
||
| Add helm repo with name `egeria` (one-time) | ||
|
|
||
| ```bash | ||
| helm repo add egeria https://github.com/odpi/egeria-charts.git | ||
| ``` | ||
|
|
||
| Once repo is added, pull latest chart versions | ||
|
|
||
| ```bash | ||
| helm repo update | ||
| ``` | ||
|
|
||
| Install app instance with name `mds1` form chart with name `egeria-server` | ||
|
|
||
| ```bash | ||
| helm install mds1 egeria/egeria-server | ||
| ``` | ||
|
|
||
| ### From local files | ||
|
|
||
| Clone the files with git and install app instance with name `mds1` using local chart located at `charts/egeria-server` | ||
|
|
||
| ```bash | ||
| git clone https://github.com/odpi/egeria-charts.git | ||
| cd egeria-charts | ||
| helm install mds1 charts/egeria-server -f charts/egeria-server/values.yaml | ||
| ``` | ||
|
|
||
| ### Uninstall the chart | ||
|
|
||
| ```bash | ||
| helm uninstall mds1 | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.