-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Rupp
committed
Sep 25, 2023
1 parent
4ea780d
commit 4b3e543
Showing
6 changed files
with
185 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Contributing Guidelines | ||
|
||
Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted. | ||
|
||
Any type of contribution is welcome; from new features, bug fixes, [tests](#testing), documentation improvements or even [adding charts to the repository](#adding-a-new-chart-to-the-repository) (if it's viable once evaluated the feasibility). | ||
|
||
## How to Contribute | ||
|
||
1. Fork this repository, develop, and test your changes. | ||
2. Submit a pull request. | ||
|
||
***NOTE***: To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs. | ||
|
||
### Technical Requirements | ||
|
||
When submitting a PR make sure that it: | ||
|
||
- Must pass CI jobs for linting and test the changes on top of different k8s platforms. | ||
- Must follow [Helm best practices](https://helm.sh/docs/chart_best_practices/). | ||
- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. This is the version that is going to be merged in the GitHub repository, then our CI/CD system is going to publish in the Helm registry a new patch version including your changes and the latest images and dependencies. | ||
|
||
### Documentation Requirements | ||
|
||
- A chart's `README.md` must include configuration options. The tables of parameters are generated based on the metadata information from the `values.yaml` file, by using [this tool](https://github.com/norwoodj/helm-docs). | ||
- A chart's `NOTES.txt` must include relevant post-installation information. | ||
- The title of the PR starts with chart name (e.g. `[universalmessaging]`) | ||
|
||
### PR Approval and Release Process | ||
|
||
1. Changes are manually reviewed by Container Inno team members. | ||
2. Once the changes are accepted, the PR is verified with a "four-eyes-principle" at the moment that includes the lint and the vulnerability checks. If that passes, the Container Inno team will review the changes and trigger any verification and functional tests on the reference environment. | ||
3. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `main` branch. | ||
|
||
***NOTE***: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the chart in the registry. | ||
|
||
|
||
### Adding a new chart to the repository | ||
|
||
There are three major technical requirements to add a new Helm chart to our catalog: | ||
|
||
- The chart should use by default official Software AG based container images or dependend publicly available 3rd party images from Docker Hub. | ||
- Follow the same structure/patterns that the rest of the Inno Container team charts (you can find a basic scaffolding in the [`template` directory](https://github.com/SoftwareAG/webmethods-helm-charts/template)). | ||
- Use an [OSI approved license](https://opensource.org/licenses) for all the software. | ||
Please, note we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources this step could take some time. |
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,3 +1,40 @@ | ||
# webmethods-helm-charts | ||
# Helm Chart Repository for Software AG webMethods Components | ||
|
||
# UNDER CONSTRUCTION PLEASE DO NOT USE | ||
This repository contains a collection of Helm charts for various webMethods components. The section *Available Charts* provides more information about the contents. We test and develop all Helm Charts for webMethods release version 10.15. | ||
|
||
## Adding the Helm Chart Repository | ||
|
||
To add this Helm chart repository to your Helm CLI, run the following command: | ||
|
||
```shell | ||
helm repo add webmethods https://open-source.softwareag.com/webmethods-helm-charts/charts | ||
``` | ||
|
||
## Available Charts | ||
|
||
| Chart Name | Description | | ||
| --- | --- | | ||
| [microservicesruntime](./microservicesruntime/helm/README.md) | Helm Chart for Microservices Runtime | | ||
| [universalmessaging](./universalmessaging/helm/README.md) | Helm Chart for Universal Messaging | | ||
|
||
Under construction are Helm Charts for API Gateway, My webMethods Server and Developer Portal. | ||
|
||
## Utilities | ||
|
||
To adopt Microservices Runtime for you deployment and environment, there is a collection of utilities: | ||
|
||
| Utility | Description | | ||
| --- | --- | | ||
| [image-builder-dcc](./utils/image-builder-dcc/README.md) | Script to create Image for Database Component Configurator (DCC) | | ||
| [PostgreSQL](./utils/postgresql/README.md) | Information to deploy a PostgreSQL database | | ||
| [BPM Demo](./utils/bpm-demo/README.md) | BPM scenarios to deploy MSR as Process Engine | | ||
| [Image Builder using Azure DevOps](./utils/image-builder-using-azure-devops/README.md) | webMethods Image builder using Azure DevOps pipelines | | ||
|
||
|
||
## Contributing | ||
|
||
If you want to contribute to this repository, please read the [contributing guidelines](./CONTRIBUTING.md) first. | ||
|
||
|
||
------------ | ||
These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project. |
Binary file not shown.
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,102 @@ | ||
apiVersion: v1 | ||
entries: | ||
common: | ||
- annotations: | ||
category: Infrastructure | ||
licenses: Apache-2.0 | ||
apiVersion: v2 | ||
appVersion: 1.0.0 | ||
created: "2023-09-25T12:07:00.490558953+02:00" | ||
description: A Library Helm Chart for grouping common logic between SoftwareAG | ||
charts. This chart is not deployable by itself. | ||
digest: deaf08e63011410e47b26862691e6048d7b852ee267afc245a30431e809c2100 | ||
home: https://softwareag.com | ||
icon: https://softwareag.com/downloads/logos/softwareag-mark.png | ||
keywords: | ||
- common | ||
- helper | ||
- template | ||
- function | ||
- softwareag | ||
maintainers: | ||
- name: SoftwareAG | ||
url: https://softwareag.com | ||
name: common | ||
sources: | ||
- https://github.com/softwareag/webmethods-helm-charts | ||
type: library | ||
urls: | ||
- https://open-source.softwareag.com/webmethods-helm-charts/charts/common-1.0.0.tgz | ||
version: 1.0.0 | ||
- annotations: | ||
category: Infrastructure | ||
licenses: Apache-2.0 | ||
apiVersion: v2 | ||
appVersion: 1.0.0 | ||
created: "2023-09-25T12:07:00.494453405+02:00" | ||
description: A Library Helm Chart for grouping common logic between SoftwareAG | ||
charts. This chart is not deployable by itself. | ||
digest: 4898d5adb1ceaafbe6c438c3347c8b3e063c6d2fb423a78729615f9e31ed802c | ||
home: https://softwareag.com | ||
icon: https://softwareag.com/downloads/logos/softwareag-mark.png | ||
keywords: | ||
- common | ||
- helper | ||
- template | ||
- function | ||
- softwareag | ||
maintainers: | ||
- name: SoftwareAG | ||
url: https://softwareag.com | ||
name: common | ||
sources: | ||
- https://github.com/softwareag/webmethods-helm-charts | ||
type: library | ||
urls: | ||
- https://open-source.softwareag.com/webmethods-helm-charts/charts/charts/common-1.0.0.tgz | ||
version: 1.0.0 | ||
microservicesruntime: | ||
- apiVersion: v2 | ||
appVersion: "10.15" | ||
created: "2023-09-25T12:07:00.492418853+02:00" | ||
dependencies: | ||
- name: common | ||
repository: https://open-source.softwareag.com/webmethods-helm-charts/charts | ||
tags: | ||
- softwareag-common | ||
version: 1.x.x | ||
description: Microservices Runtime (MSR) Helm Chart for Kubernetes | ||
digest: f163a41276a1fd61dc01bb6898b95977e939aff21170772bd5d4fa7bcbef67ad | ||
name: microservicesruntime | ||
type: application | ||
urls: | ||
- https://open-source.softwareag.com/webmethods-helm-charts/charts/microservicesruntime-1.1.0.tgz | ||
version: 1.1.0 | ||
- apiVersion: v2 | ||
appVersion: "10.15" | ||
created: "2023-09-25T12:07:00.495659557+02:00" | ||
description: A Microservices Runtime (MSR) Helm chart for Kubernetes | ||
digest: 79c75f859cdff52a0d56526f3d36929c499aad586350260b0a851fd0a3a3596d | ||
name: microservicesruntime | ||
type: application | ||
urls: | ||
- https://open-source.softwareag.com/webmethods-helm-charts/charts/charts/microservicesruntime-1.1.0.tgz | ||
version: 1.1.0 | ||
universalmessaging: | ||
- apiVersion: v2 | ||
appVersion: "10.15" | ||
created: "2023-09-25T12:07:00.493862628+02:00" | ||
dependencies: | ||
- name: common | ||
repository: https://open-source.softwareag.com/webmethods-helm-charts/charts | ||
tags: | ||
- softwareag-common | ||
version: 1.x.x | ||
description: Universal Messaging (UM) Helm Chart for Kubernetes | ||
digest: a7b41e3c4d200c79326c9f660b2c75cfb5d6ba474bad5ec6252b4677b0c1282b | ||
name: universalmessaging | ||
type: application | ||
urls: | ||
- https://open-source.softwareag.com/webmethods-helm-charts/charts/universalmessaging-1.0.0.tgz | ||
version: 1.0.0 | ||
generated: "2023-09-25T12:07:00.489753268+02:00" |
Binary file not shown.
Binary file not shown.