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.

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

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

roel4ez
Copy link
Collaborator

@roel4ez roel4ez commented Sep 16, 2024

Change Description

The documentation on deploying Presidio to K8S with Helm is outdated and doesn't work. This PR fixes the documentation to a more expanded version for deploying through Helm.

Note

The note syntax of mkdocs is not supported by the linter. This PR also changes the notes on the page slightly so that the linter does not complain, and notes still show up correct in mkdocs.

Checklist

  • I have reviewed the contribution guidelines
  • I have signed the CLA (if required)
  • [ ] My code includes unit tests
  • All unit tests and lint checks pass locally
  • My PR contains documentation updates / additions if required

@@ -40,8 +40,8 @@ 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**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is intentional. mkdocs then renders this as a colored box

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants