-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: adding uds core prerequisites documentation (#636)
## Description Each component within UDS Core could potentially have 'prerequisites'. This is an attempt to document known instances and ways to help users stand up UDS Core more easily. ## Related Issue Fixes #294 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <[email protected]>
- Loading branch information
1 parent
7ecd130
commit 6225766
Showing
2 changed files
with
109 additions
and
5 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
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 |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: UDS Core Prerequisites | ||
| type: docs | ||
| weight: 4 | ||
| --- | ||
|
|
||
| ## UDS Core Prerequisites | ||
|
|
||
| `UDS Core` can run in any [CNCF conformant Kubernetes distribution](https://www.cncf.io/training/certification/software-conformance/), but sometimes customizations are needed based on environments. This is an attempt to document and link to relevant information to aid in setting up your Kubernetes environment and hosts to ensure a successful `UDS Core` installation. | ||
|
|
||
| ### Cluster Requirements | ||
|
|
||
| When running Kubernetes on any type of host it is important to ensure you are following the upstream documentation from the Kubernetes distribution regarding prerequisites. A few links to upstream documentation are provided below for convenience. | ||
|
|
||
| #### RKE2 | ||
|
|
||
| - [General installation requirements](https://docs.rke2.io/install/requirements) | ||
| - [Disabling Firewalld to prevent networking conflicts](https://docs.rke2.io/known_issues#firewalld-conflicts-with-default-networking) | ||
| - [Modifying NetworkManager to prevent CNI conflicts](https://docs.rke2.io/known_issues#networkmanager) | ||
| - [Known Issues](https://docs.rke2.io/known_issues) | ||
|
|
||
| #### K3S | ||
|
|
||
| - [General installation requirements](https://docs.k3s.io/installation/requirements) | ||
| - [Known Issues](https://docs.k3s.io/known-issues) | ||
|
|
||
| #### EKS | ||
|
|
||
| - [General installation requirements](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html) | ||
| - [Troubleshooting Guide](https://docs.aws.amazon.com/eks/latest/userguide/troubleshooting.html) | ||
|
|
||
| #### AKS | ||
|
|
||
| - [General installation requirements](https://learn.microsoft.com/en-us/azure/well-architected/service-guides/azure-kubernetes-service) | ||
| - [Troubleshooting Guide](https://learn.microsoft.com/en-us/troubleshoot/azure/azure-kubernetes/welcome-azure-kubernetes) | ||
|
|
||
| ### UDS Core Requirements | ||
|
|
||
| The below are specific requirements for running UDS Core. Some of them are tied to the entire stack of UDS Core and some are more specific to certain components. If you encounter issues with a particular component of core, this can be a good list to check to validate you met all the prerequisite requirements for that specific application. | ||
|
|
||
| #### Default Storage Class | ||
|
|
||
| Several UDS Core components require persistent volumes that will be provisioned using the default storage class via dynamic volume provisioning. Ensure that your cluster includes a default storage class prior to deploying. You can validate by running the below command (see example output which includes `(default)` next to the `local-path` storage class): | ||
|
|
||
| ```console | ||
| ❯ kubectl get storageclass | ||
| NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE | ||
| local-path (default) rancher.io/local-path Delete WaitForFirstConsumer false 55s | ||
| ``` | ||
|
|
||
| #### Network Policy Support | ||
|
|
||
| The UDS Operator will dynamically provision network policies to secure traffic between components in UDS Core. To ensure these are effective, validate that your CNI supports enforcing network policies. In addition, UDS Core makes use of some CIDR based policies for communication with the KubeAPI server. If you are using Cilium, support for node addressability with CIDR based policies must be enabled with a [feature flag](https://docs.cilium.io/en/stable/security/policy/language/#selecting-nodes-with-cidr-ipblock). | ||
|
|
||
| #### Istio | ||
|
|
||
| Istio requires a number of kernel modules to be loaded for full functionality. The below is a script that will ensure these modules are loaded and persisted across reboots (see also Istio's [upstream requirements list](https://istio.io/latest/docs/ops/deployment/platform-requirements/)). Ideally this script is used as part of an image build or cloud-init process on each node. | ||
|
|
||
| ```console | ||
| modules=("br_netfilter" "xt_REDIRECT" "xt_owner" "xt_statistic" "iptable_mangle" "iptable_nat" "xt_conntrack" "xt_tcpudp") | ||
| for module in "${modules[@]}"; do | ||
| modprobe "$module" | ||
| echo "$module" >> "/etc/modules-load.d/istio-modules.conf" | ||
| done | ||
| ``` | ||
|
|
||
| In addition, to run Istio ingress gateways (part of Core) you will need to ensure your cluster supports dynamic load balancer provisioning when services of type LoadBalancer are created. Typically in cloud environments this is handled using a cloud provider's controller (example: [AWS LB Controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller)). When deploying on-prem, this is commonly done by using a "bare metal" load balancer provisioner like [MetalLB](https://metallb.universe.tf/) or [kube-vip](https://kube-vip.io/). Certain distributions may also include ingress controllers that you will want to disable as they may conflict with Istio (example: RKE2 includes ingress-nginx). | ||
|
|
||
| #### NeuVector | ||
|
|
||
| NeuVector historically has functioned best when the host is using cgroup v2. Cgroup v2 is enabled by default on many modern Linux distributions, but you may need to enable it depending on your operating system. Enabling this tends to be OS specific, so you will need to evaluate this for your specific hosts. | ||
|
|
||
| #### Promtail | ||
|
|
||
| In order to ensure that Promtail is able to scrape the necessary logs concurrently you may need to adjust some kernel parameters for your hosts. The below is a script that can be used to adjust these parameters to suitable values and ensure they are persisted across reboots. Ideally this script is used as part of an image build or cloud-init process on each node. | ||
|
|
||
| ```console | ||
| declare -A sysctl_settings | ||
| sysctl_settings["fs.nr_open"]=13181250 | ||
| sysctl_settings["fs.inotify.max_user_instances"]=1024 | ||
| sysctl_settings["fs.inotify.max_user_watches"]=1048576 | ||
| sysctl_settings["fs.file-max"]=13181250 | ||
|
|
||
| for key in "${!sysctl_settings[@]}"; do | ||
| value="${sysctl_settings[$key]}" | ||
| sysctl -w "$key=$value" | ||
| echo "$key=$value" > "/etc/sysctl.d/$key.conf" | ||
| done | ||
| sysctl -p | ||
| ``` | ||
|
|
||
| #### Metrics Server | ||
|
|
||
| Metrics server is provided as an optional component in UDS Core and can be enabled if needed. For distros where metrics-server is already provided, ensure that you do NOT enable metrics-server. See the below as an example for enabling metrics-server if your cluster does not include it. | ||
|
|
||
| ```yaml | ||
| ... | ||
| - name: uds-core | ||
| repository: ghcr.io/defenseunicorns/packages/private/uds/core | ||
| ref: 0.25.2-unicorn | ||
| optionalComponents: | ||
| - metrics-server | ||
| ... | ||
| ``` |