[ci-skip] Add README.md files

Primary Changes -------------- Add readme files for all charts Update the values.yaml files Update the version in chart.yaml file Modifications in charts --------------------- platforms/r3-corda/charts/doorman-tls platforms/r3-corda/charts/doorman platforms/r3-corda/charts/generate-certs platforms/r3-corda/charts/h2 platforms/r3-corda/charts/mongodb-tls platforms/r3-corda/charts/mongodb platforms/r3-corda/charts/nms-tls platforms/r3-corda/charts/nms platforms/r3-corda/charts/node-initial-registration platforms/r3-corda/charts/node platforms/r3-corda/charts/notary-initial-registration platforms/r3-corda/charts/notary Fixes #2285 Signed-off-by: sailajakommineni <[email protected]>
hyperledger-bevel · Jul 13, 2023 · 5a28f80 · 5a28f80
1 parent eac67df
commit 5a28f80
Show file tree

Hide file tree

Showing 35 changed files with 2,425 additions and 633 deletions.
diff --git a/platforms/r3-corda/charts/doorman-tls/Chart.yaml b/platforms/r3-corda/charts/doorman-tls/Chart.yaml
@@ -6,6 +6,6 @@
 
 apiVersion: v1
 appVersion: "2.0"
-description: A Helm chart for deploying doorman with TLS connection .
+description: "R3-corda-os: Deploys the doorman with TLS connection enabled."
 name: doorman-tls
-version: '0.14.0'
+version: '0.14.1'
diff --git a/platforms/r3-corda/charts/doorman-tls/README.md b/platforms/r3-corda/charts/doorman-tls/README.md
@@ -0,0 +1,173 @@
+[//]: # (##############################################################################################)
+[//]: # (Copyright Accenture. All Rights Reserved.)
+[//]: # (SPDX-License-Identifier: Apache-2.0)
+[//]: # (##############################################################################################)
+
+<a name = "deploy doorman-tls"></a>
+# Doorman Deployment
+
+- [Doorman-tls Deployment Helm Chart](#Doorman-tls-deployment-helm-chart)
+- [Prerequisites](#prerequisites)
+- [Chart Structure](#chart-structure)
+- [Configuration](#configuration)
+- [Deployment](#deployment)
+- [Contributing](#contributing)
+- [License](#license)
+
+<a name = "Doorman-tls-deployment-helm-chart"></a>
+## Doorman-tls Deployment Helm Chart
+---
+This [Helm chart](https://github.com/hyperledger/bevel/tree/develop/platforms/r3-corda/charts/doorman-tls) deploys the doorman with TLS connection enabled, which helps establish trust and secure communication within the network by acting as a gatekeeper for network participants. 
+
+
+<a name = "prerequisites"></a>
+## Prerequisites
+---
+Before deploying the chart please ensure you have the following prerequisites:
+
+- Mongodb for doorman-tls database up and running.
+- Kubernetes cluster up and running.
+- A HashiCorp Vault instance is set up and configured to use Kubernetes service account token-based authentication.
+- The Vault is unsealed and initialized.
+- Helm is installed.
+
+
+<a name = "chart-structure"></a>
+## Chart Structure
+---
+This chart has following structue:
+
+```
+  
+  ├── doorman-tls
+  │   ├── Chart.yaml
+  │   ├── templates
+  │   │   ├── deployment.yaml
+  │   │   ├── pvc.yaml
+  │   │   └── service.yaml
+  │   └── values.yaml
+```
+
+Type of files used:
+
+- `templates`       : This directory contains the Kubernetes manifest templates that define the resources to be deployed.
+- `deployment.yaml` : This file is a configuration file for deployement in Kubernetes.It creates a deployment file with a specified number of replicas and defines various settings for the deployment.Including volume mounts, environment variables, and initialization tasks using init containers.  
+- `pvc.yaml`        : A PersistentVolumeClaim (PVC) is a request for storage by a user.
+- `service.yaml`    : This file defines a Kubernetes Service with multiple ports for protocols and targets, and supports Ambassador proxy annotations for specific configurations when using the "ambassador" proxy provider.
+- `chart.yaml`      : Provides metadata about the chart, such as its name, version, and description.
+- `values.yaml`     : Contains the default configuration values for the chart. It includes configuration for the metadata, image, service, Vault, etc.
+
+
+<a name = "configuration"></a>
+## Configuration
+---
+The [values.yaml](https://github.com/hyperledger/bevel/blob/develop/platforms/r3-corda/charts/doorman-tls/values.yaml) file contains configurable values for the Helm chart. We can modify these values according to the deployment requirements. Here are some important configuration options:
+
+
+## Parameters
+---
+
+### Name
+
+| Name       | Description                                        | Default Value |
+| -----------| -------------------------------------------------- | ------------- |
+| name       | Provide the name of the node                       | network-map   |
+
+### Metadata
+
+| Name            | Description                                                         | Default Value |
+| ----------------| --------------------------------------------------------------------| ------------- |
+| namespace       | Provide the namespace for the doorman-tls Generator                 | default       |
+| labels          | Provide any additional labels for the doorman-tls Generator         | ""            |
+
+### Image
+
+| Name                     | Description                                                                                | Default Value   |
+| ------------------------ | -------------------------------------------------------                                    | --------------- |
+| initContainerName        | Provide the alpine utils image, which is used for all init-containers of deployments/jobs  | ""              |
+| containerName            | Provide the containerName of image                                                         | ""              |
+| imagePullSecret          | Provide the image pull secret of image                                                     | regcred         |
+| mountPath                | Provide enviroment variable for container image                                            | /opt/doorman    |
+| env                      | These env are used by the Doorman application to connect to the MongoDB database           | ""              |
+
+
+### Vault
+
+| Name                      | Description                                                               | Default Value   |
+| ------------------------- | --------------------------------------------------------------------------| -------------   |
+| address                   | Address/URL of the Vault server                                           | ""              |
+| role                      | Role used for authentication with Vault                                   | vault-role      |
+| authpath                  | Authentication path for Vault                                             | cordanms        |
+| secretprefix              | Provide the kubernetes auth backed configured in vault                    | ""              |
+| imagesecretname           | specify the name of the Kubernetes secret                                 | ""              |
+| serviceaccountname        | To authenticate with the Vault server and retrieve the secrets            |vault-auth-issuer|
+
+
+### Healthcheck
+
+  Tasks performed in this container is used for database health check.
+  If db is up and running, starts the corda doorman-tls main container.
+
+
+<a name = "deployment"></a>
+## Deployment
+---
+
+To deploy the Doorman-tls Helm chart, follow these steps:
+
+1. Modify the [values.yaml](https://github.com/hyperledger/bevel/blob/develop/platforms/r3-corda/charts/doorman-tls/values.yaml) file to set the desired configuration values.
+2. Run the following Helm command to install, upgrade,verify, delete the chart:
+
+To install the chart:
+```bash
+helm repo add bevel https://hyperledger.github.io/bevel/
+helm install <release-name> ./doorman-tls
+```
+
+To upgrade the chart:
+```bash
+helm upgrade <release-name> ./doorman-tls
+```
+
+To verify the deployment:
+```bash
+kubectl get jobs -n <namespace>
+```
+Note : Replace `<namespace>` with the actual namespace where the Job was created. This command will display information about the Job, including the number of completions and the current status of the Job's pods.
+
+To delete the chart: 
+```bash
+helm uninstall <release-name>
+```
+Note : Replace `<release-name>` with the desired name for the release.
+
+
+<a name = "contributing"></a>
+## Contributing
+---
+If you encounter any bugs, have suggestions, or would like to contribute to the [Doorman-tls Deployment Helm Chart](https://github.com/hyperledger/bevel/tree/develop/platforms/r3-corda/charts/doorman-tls), please feel free to open an issue or submit a pull request on the [project's GitHub repository](https://github.com/hyperledger/bevel).
+
+<a name = "license"></a>
+## License
+
+This chart is licensed under the Apache v2.0 license.
+
+Copyright &copy; 2023 Accenture
+
+### Attribution
+
+This chart is adapted from the [charts](https://hyperledger.github.io/bevel/) which is licensed under the Apache v2.0 License which is reproduced here:
+
+```
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
diff --git a/platforms/r3-corda/charts/doorman-tls/values.yaml b/platforms/r3-corda/charts/doorman-tls/values.yaml
@@ -10,23 +10,23 @@
 
 #Provide the Name for node to be deployed
 #Eg. nodeName: network-map
-nodeName:
+nodeName: network-map
 
 metadata:
   #Provide the namespace for organization's peer
   #Eg. namespace: default
-  namespace:
+  namespace: default
 
 image:
   #Provide the name of image for init container
   #Eg. initContainerName: hyperledgerlabs/alpine-utils:1.0
-  initContainerName: 
+  initContainerName: hyperledgerlabs/alpine-utils:1.0
   #Provide the containerName of image
   #Eg. containerName: hyperledgerlabs/nms:0.3.6-nms
-  containerName: 
+  containerName: hyperledgerlabs/nms:0.3.6-nms
   #Provide the image pull secret of image
   #Eg. pullSecret: regcred
-  imagePullSecret:
+  imagePullSecret: regcred
   #Provide enviroment variable for container image
   mountPath:
     #Provide the path for base dir
@@ -61,7 +61,7 @@ image:
 service:
   #Provide the type of service
   #Eg. type: NodePort
-  type:
+  type: NodePort
   #Provide the node port for node service to be accessible outside
   #Eg. nodePort: 30050
   nodePort:
@@ -93,9 +93,9 @@ vault:
   address:
   #Provide the vaultrole
   #Eg. role: vault-role
-  role:
+  role: vault-role
   #Eg. authpath: cordanms
-  authpath:
+  authpath: cordanms
   #Provide the kubernetes auth backed configured in vault
   #Eg. secretprefix:
   secretprefix:

diff --git a/platforms/r3-corda/charts/doorman/Chart.yaml b/platforms/r3-corda/charts/doorman/Chart.yaml
@@ -6,6 +6,6 @@
 
 apiVersion: v1
 appVersion: "2.0"
-description: A Helm chart for Kubernetes
+description: "R3-corda-os: Deploys the doorman service for r3corda node."
 name: doorman
-version: '0.14.0'
+version: '0.14.1'