diff --git a/devops/gcp/configmap/README.md b/devops/gcp/configmap/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f3ef9a7ee9aa34eaa4afbf7d1bc4122d49956f65 --- /dev/null +++ b/devops/gcp/configmap/README.md @@ -0,0 +1,155 @@ +<!--- Configmap --> + +# Configmap helm chart + +## Introduction + +This chart bootstraps a configmap deployment on a [Kubernetes](https://kubernetes.io) cluster using [Helm](https://helm.sh) package manager. + +## Prerequisites + +The code was tested on **Kubernetes cluster** (v1.21.11) with **Istio** (1.12.6) + > Istio is installed with Istio Ingress Gateway + +- Kubernetes cluster version can be checked with the command: + + `kubectl version --short | grep Server` + + The output will be similar to the following: + + ```console + Server Version: v1.21.11-gke.1100 + ``` + +- Istio version can be checked in different ways, it is out of scope for this README. You can find more information [here](https://istio.io/latest/docs/setup/install/). + + The following command shows how to check version if Anthos Service Mesh is used: + + `kubectl -n istio-system get pods -lapp=istiod -o=jsonpath='{.items[0].metadata.labels.istio\.io/rev}'` + + The output will be similar to the following: + + ```console + asm-1132-5 + ``` + +> It is possible to use other versions, but it hasn't been tested + +This example describes installation in **Development mode**: + +- In this mode helm chart is installed to the namespace **not labeled with Istio**. + > More information about labeling can be found [here](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection) (Istio) or [here](https://cloud.google.com/service-mesh/docs/managed/select-a-release-channel#default-injection-labels) (Anthos Service Mesh) + + You can find all labels for your namespace with the command: + + `kubectl get namespace <namespace> -o jsonpath={.metadata.labels}` + + The output shows that there are no any labels related to Istio: + + ```console + {"kubernetes.io/metadata.name":"default"} + ``` + + When the namespace is labeled with Istio, the output could be: + + ```console + {"istio-injection":"enabled","kubernetes.io/metadata.name":"default"} + ``` + +### Operation system + +The code works in Debian-based Linux (Debian 10 and Ubuntu 20.04) and Windows WSL 2. Also, it works but is not guaranteed in Google Cloud Shell. All other operating systems, including macOS, are not verified and supported. + +### Packages + +Packages are only needed for installation from a local computer. + +- **HELM** (version: v3.7.1 or higher) [helm](https://helm.sh/docs/intro/install/) + + Helm version can be checked with the command: + + `helm version --short` + + The output will be similar to the following: + + ```console + v3.7.1+gd141386 + ``` + +- **Kubectl** (version: v1.21.0 or higher) [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) + + Kubectl version can be checked with the command: + + `kubectl version --short | grep Client` + + The output will be similar to the following: + + ```console + Client Version: v1.21.0 + ``` + +## Installation + +First you need to set variables in **values.yaml** file using any code editor. Some of the values are prefilled, but you need to specify some values as well. You can find more information about them below. + +### Common variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**logLevel** | logging level | string | INFO | yes +**springProfilesActive** | active spring profile | string | gcp | yes + +### GCP variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**acceptHttp** | accept Http traffic | string | true | yes +**googleAudiences** | your GCP client ID | string | - | yes + +> googleAudiences: If you are connected to GCP console with `gcloud auth application-default login --no-browser` from your terminal, you can get your client_id using the command: + +```console +cat ~/.config/gcloud/application_default_credentials.json | grep client_id +``` + +### Bootstrap variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**dataPartitionId** | ID of data partition | string | - | yes +**entitlementsHost** | Entitlements host URL | string | http://entitlements | yes +**defaultLegalTag** | Default legal tag | string | default-data-tag| yes +**legalHost** | Legal host URL | string | http://legal | yes + +### Config variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**configmap** | configmap to be used | string | legal-config | yes +**appName** | name of the app | string | legal | yes +**onPremEnabled** | whether on-prem is enabled | boolean | false | yes +**bootstrapEnabled** | whether bootstrap is enabled | boolean | false | yes + +### Install the helm chart + +Run this command from within this directory: + +```console +helm install gcp-legal-configmap . +``` + +## Uninstalling the Chart + +To uninstall the helm deployment: + +```console +helm uninstall gcp-legal-configmap +``` + +To delete secrets and PVCs: + +```console +kubectl delete secret --all; kubectl delete pvc --all +``` + +[Move-to-Top](#configmap-helm-chart) diff --git a/devops/gcp/deploy/README.md b/devops/gcp/deploy/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c686ea96234bf47b6bcdfc5fbaac9ea438e2d01a --- /dev/null +++ b/devops/gcp/deploy/README.md @@ -0,0 +1,150 @@ +<!--- Deploy --> + +# Deploy helm chart + +## Introduction + +This chart bootstraps a deployment on a [Kubernetes](https://kubernetes.io) cluster using [Helm](https://helm.sh) package manager. + +## Prerequisites + +The code was tested on **Kubernetes cluster** (v1.21.11) with **Istio** (1.12.6) + > Istio is installed with Istio Ingress Gateway + +- Kubernetes cluster version can be checked with the command: + + `kubectl version --short | grep Server` + + The output will be similar to the following: + + ```console + Server Version: v1.21.11-gke.1100 + ``` + +- Istio version can be checked in different ways, it is out of scope for this README. You can find more information [here](https://istio.io/latest/docs/setup/install/). + + The following command shows how to check version if Anthos Service Mesh is used: + + `kubectl -n istio-system get pods -lapp=istiod -o=jsonpath='{.items[0].metadata.labels.istio\.io/rev}'` + + The output will be similar to the following: + + ```console + asm-1132-5 + ``` + +> It is possible to use other versions, but it hasn't been tested + +This example describes installation in **Development mode**: + +- In this mode helm chart is installed to the namespace **not labeled with Istio**. + > More information about labeling can be found [here](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection) (Istio) or [here](https://cloud.google.com/service-mesh/docs/managed/select-a-release-channel#default-injection-labels) (Anthos Service Mesh) + + You can find all labels for your namespace with the command: + + `kubectl get namespace <namespace> -o jsonpath={.metadata.labels}` + + The output shows that there are no any labels related to Istio: + + ```console + {"kubernetes.io/metadata.name":"default"} + ``` + + When the namespace is labeled with Istio, the output could be: + + ```console + {"istio-injection":"enabled","kubernetes.io/metadata.name":"default"} + ``` + +### Operation system + +The code works in Debian-based Linux (Debian 10 and Ubuntu 20.04) and Windows WSL 2. Also, it works but is not guaranteed in Google Cloud Shell. All other operating systems, including macOS, are not verified and supported. + +### Packages + +Packages are only needed for installation from a local computer. + +- **HELM** (version: v3.7.1 or higher) [helm](https://helm.sh/docs/intro/install/) + + Helm version can be checked with the command: + + `helm version --short` + + The output will be similar to the following: + + ```console + v3.7.1+gd141386 + ``` + +- **Kubectl** (version: v1.21.0 or higher) [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) + + Kubectl version can be checked with the command: + + `kubectl version --short | grep Client` + + The output will be similar to the following: + + ```console + Client Version: v1.21.0 + ``` + +## Installation + +First you need to set variables in **values.yaml** file using any code editor. Some of the values are prefilled, but you need to specify some values as well. You can find more information about them below. + +### Common variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**requestsCpu** | amount of requests CPU | string | 0.1 | yes +**requestsMemory** | amount of requests memory| string | 384M | yes +**limitsCpu** | CPU limit | string | 1 | yes +**limitsMemory** | memory limit | string | 1G | yes +**serviceAccountName** | name of your service account | string | legal | yes +**imagePullPolicy** | when to pull image | string | IfNotPresent | yes +**image** | your image name | string | - | yes + +### Bootstrap variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**bootstrapImage** | name of the bootstrap image | string | - | yes +**bootstrapServiceAccountName** | name of the bootstrap SA | string | - | yes + +### Config variables + +| Name | Description | Type | Default |Required | +|------|-------------|------|---------|---------| +**configmap** | configmap to be used | string | legal-config | yes +**appName** | name of the app | string | legal | yes +**minioSecretName** | Secret name for minio service | string | legal-minio-secret | yes +**postgresSecretName** | Secret name for postgres service | string | legal-postgres-secret | yes +**rabbitmqSecretName** | Secret name for rabbitmq service | string | rabbitmq-secret | yes +**bootstrapSecretName** | Secret name for bootstrap | string | datafier-secret | yes +**onPremEnabled** | whether on-prem is enabled | boolean | false | yes +**bootstrapEnabled** | whether bootstrap is enabled | boolean | false | yes +**domain** | your domain | string | - | yes + +### Install the helm chart + +Run this command from within this directory: + +```console +helm install gcp-legal-deploy . +``` + +## Uninstalling the Chart + +To uninstall the helm deployment: + +```console +helm uninstall gcp-legal-deploy +``` + +To delete secrets and PVCs: + +```console +kubectl delete secret --all; kubectl delete pvc --all +``` + +[Move-to-Top](#deploy-helm-chart) diff --git a/devops/gcp/deploy/templates/legal-virtual-service.yml b/devops/gcp/deploy/templates/legal-virtual-service.yml index 76e2a945d609bf5a8162c10d88b23f49edda8e68..e516e72aa90823c16f39c5505c8b4b4771defcca 100644 --- a/devops/gcp/deploy/templates/legal-virtual-service.yml +++ b/devops/gcp/deploy/templates/legal-virtual-service.yml @@ -5,8 +5,10 @@ metadata: namespace: "{{ .Release.Namespace }}" spec: hosts: - {{- if .Values.conf.domain }} + {{- if and .Values.conf.domain .Values.conf.onPremEnabled }} - {{ printf "osdu.%s" .Values.conf.domain | quote }} + {{- else if .Values.conf.domain }} + - {{ .Values.conf.domain | quote }} {{- else }} - "*" {{- end }}