Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify the docs on deploying presidio to k8s #1453

Merged
merged 7 commits into from
Oct 14, 2024
Merged

docs: clarify the docs on deploying presidio to k8s #1453

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2b32ddc
Clarifies the docs on deploying presidio to K8S
roel4ez Sep 16, 2024
4206794
fix to not use github note spec since it's mkdocs
roel4ez Sep 16, 2024
f41ec45
Merge branch 'main' into docs/clarify-k8s-installation
omri374 Sep 22, 2024
4a04c89
Update index.md
omri374 Oct 14, 2024
cc8e629
Update index.md
omri374 Oct 14, 2024
21f8257
Update index.md
omri374 Oct 14, 2024
b989181
Merge branch 'main' into docs/clarify-k8s-installation
omri374 Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions docs/samples/deployments/k8s/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ You can install Presidio locally using [KIND](https://github.com/kubernetes-sigs
1. A Kubernetes 1.18+ cluster with [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) enabled. If you are using [AKS](https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes) RBAC is enabled by default.

!!! note: Note
Note the pod's resources requirements (CPU and memory) and plan the cluster accordingly.
Note the pod's resource requirements (CPU and memory) and plan the cluster accordingly.

2. [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) installed. Verify you can communicate with the cluster by running:

Expand All @@ -59,12 +59,26 @@ You can install Presidio locally using [KIND](https://github.com/kubernetes-sigs

2. Optional - Ingress controller for presidio API, e.g., [NGINX](https://docs.microsoft.com/en-us/azure/aks/ingress-tls).

> Note: Presidio is not deployed with an ingress controller by default.
to change this behavior, deploy the helm chart with `ingress.enabled=true` and specify they type of ingress controller to be used with `ingress.class=nginx` (supported classes are: `nginx`).
> **NOTE**:
> Presidio is deployed with an ingress controller by default, and uses `nginx` as `ingress.class`. To change
> this behavior, deploy the helm chart with `ingress.enabled=false`.

3. Deploy from `/docs/samples/deployments/k8s/charts/presidio`

```sh
# Based on the DOCKER_REGISTRY and PRESIDIO_LABEL from the previous steps
helm install --name demo --set registry=${DOCKER_REGISTRY},tag=${PRESIDIO_LABEL} . --namespace presidio
# Choose a namespace and ensure it is created
NAMESPACE=presidio

# Choose the tag, from mcr.microsoft.com, e.g. `latest`
TAG=latest

# Choose a name for the deployment
NAME=<name>

# Use Helm to install all required components
helm install $NAME . --set tag=$PRESIDIO_LABEL --namespace $NAMESPACE

# If you have your own images in a separate ACR, run
DOCKER_REGISTRY=<your_registry>
helm install $NAME . --set registry=$DOCKER_REGISTRY,tag=$PRESIDIO_LABEL . --namespace $NAMESPACE
```
Loading