-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #75 from lalithkota/main
eSignet 1.4.1 upgraded. With Mock ID.
- Loading branch information
Showing
6 changed files
with
14 additions
and
147 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 |
|---|---|---|
| @@ -1,131 +1,3 @@ | ||
| # Artifactory | ||
|
|
||
| Helm chart for installing Artifactory | ||
|
|
||
| ## TL;DR | ||
|
|
||
| ```console | ||
| $ helm repo add mosip https://mosip.github.io | ||
| $ helm install my-release mosip/artifactory | ||
| ``` | ||
|
|
||
| ## Introduction | ||
|
|
||
| %%INTRODUCTION%% (check existing examples) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.12+ | ||
| - Helm 3.1.0 | ||
| - PV provisioner support in the underlying infrastructure | ||
| - ReadWriteMany volumes for deployment scaling | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| To install the chart with the release name `my-release`: | ||
|
|
||
| ```console | ||
| helm install my-release mosip/artifactory | ||
| ``` | ||
|
|
||
| The command deploys artifactory on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. | ||
|
|
||
| > **Tip**: List all releases using `helm list` | ||
| ## Uninstalling the Chart | ||
|
|
||
| To uninstall/delete the `my-release` deployment: | ||
|
|
||
| ```console | ||
| helm delete my-release | ||
| ``` | ||
|
|
||
| The command removes all the Kubernetes components associated with the chart and deletes the release. | ||
|
|
||
| ## Parameters | ||
|
|
||
| See https://github.com/bitnami-labs/readmenator to create the table | ||
|
|
||
| The above parameters map to the env variables defined in [bitnami/artifactory](http://github.com/bitnami/bitnami-docker-artifactory). For more information please refer to the [bitnami/artifactory](http://github.com/bitnami/bitnami-docker-artifactory) image documentation. | ||
|
|
||
| Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, | ||
|
|
||
| ```console | ||
| helm install my-release \ | ||
| --set artifactoryUsername=admin \ | ||
| --set artifactoryPassword=password \ | ||
| --set mariadb.auth.rootPassword=secretpassword \ | ||
| bitnami/artifactory | ||
| ``` | ||
|
|
||
| The above command sets the artifactory administrator account username and password to `admin` and `password` respectively. Additionally, it sets the MariaDB `root` user password to `secretpassword`. | ||
|
|
||
| > NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available. | ||
| Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, | ||
|
|
||
| ```console | ||
| helm install my-release -f values.yaml bitnami/artifactory | ||
| ``` | ||
|
|
||
| > **Tip**: You can use the default [values.yaml](values.yaml) | ||
| ## Configuration and installation details | ||
|
|
||
| ### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/) | ||
|
|
||
| It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image. | ||
|
|
||
| Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist. | ||
|
|
||
| ### External database support | ||
|
|
||
| %%IF NEEDED%% | ||
|
|
||
| You may want to have artifactory connect to an external database rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the [`externalDatabase` parameter](#parameters). You should also disable the MariaDB installation with the `mariadb.enabled` option. Here is an example: | ||
|
|
||
| ```console | ||
| mariadb.enabled=false | ||
| externalDatabase.host=myexternalhost | ||
| externalDatabase.user=myuser | ||
| externalDatabase.password=mypassword | ||
| externalDatabase.database=mydatabase | ||
| externalDatabase.port=3306 | ||
| ``` | ||
|
|
||
| ### TLS secrets | ||
|
|
||
| The chart also facilitates the creation of TLS secrets for use with the Ingress controller, with different options for certificate management. [Learn more about TLS secrets](https://docs.bitnami.com/kubernetes/apps/artifactory/administration/enable-tls/). | ||
|
|
||
| ### %%OTHER_SECTIONS%% | ||
|
|
||
| ## Persistence | ||
|
|
||
| The [Bitnami artifactory](https://github.com/bitnami/bitnami-docker-artifactory) image stores the artifactory data and configurations at the `/bitnami` path of the container. Persistent Volume Claims are used to keep the data across deployments. [Learn more about persistence in the chart documentation](https://docs.bitnami.com/kubernetes/apps/artifactory/configuration/chart-persistence/). | ||
|
|
||
| ### Additional environment variables | ||
|
|
||
| In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the `extraEnvVars` property. | ||
|
|
||
| ```yaml | ||
| artifactory: | ||
| extraEnvVars: | ||
| - name: LOG_LEVEL | ||
| value: error | ||
| ``` | ||
| Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the `extraEnvVarsCM` or the `extraEnvVarsSecret` values. | ||
|
|
||
| ### Sidecars | ||
|
|
||
| If additional containers are needed in the same pod as artifactory (such as additional metrics or logging exporters), they can be defined using the `sidecars` parameter. If these sidecars export extra ports, extra port definitions can be added using the `service.extraPorts` parameter. [Learn more about configuring and using sidecar containers](https://docs.bitnami.com/kubernetes/apps/artifactory/administration/configure-use-sidecars/). | ||
|
|
||
| ### Pod affinity | ||
|
|
||
| This chart allows you to set your custom affinity using the `affinity` parameter. Find more information about Pod affinity in the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). | ||
|
|
||
| As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/master/bitnami/common#affinities) chart. To do so, set the `podAffinityPreset`, `podAntiAffinityPreset`, or `nodeAffinityPreset` parameters. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Find more information about how to deal with common errors related to Bitnami's Helm charts in [this troubleshooting guide](https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues). | ||
| Helm chart for installing MOSIP's Artifactory. |
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
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
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