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

chore: adding uds core prerequisites documentation #636

Merged
merged 13 commits into from
Sep 4, 2024
75 changes: 75 additions & 0 deletions docs/deployment/prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: UDS Prerequisites
type: docs
weight: 4
---

## UDS installation prerequisites

`UDS Core` could run in any [Kuberentes](https://kubernetes.io/) setup, but sometimes customizations are needed based on environemnts. This is an attempt to document and link to relevant information to aid in setting up your [Kuberentes](https://kubernetes.io/) environment to ensure a successful `UDS Core` installation.
lemonprogis marked this conversation as resolved.
Show resolved Hide resolved

### RHEL
---
#### *ISTIO related changes*
Solution is to create file `/etc/modules-load.d/istio-iptables.conf` with this content:

```bash
# These modules need to be loaded on boot so that Istio (as required by
# UDS Core) runs properly.
#
# See also: https://github.com/istio/istio/issues/23009

br_netfilter
nf_nat
xt_REDIRECT
xt_owner
iptable_nat
iptable_mangle
iptable_filter
```

```bash
sudo systemctl stop firewalld
sudo systemctl disable firewalld
```
mjnagel marked this conversation as resolved.
Show resolved Hide resolved

### RKE2
---
* [Installation requirements](https://docs.rke2.io/install/requirements)
* [Firewalld network conflicts](https://docs.rke2.io/known_issues#firewalld-conflicts-with-default-networking)
* [Disabling components, such as Ingress which clashes with istio](https://docs.rke2.io/advanced#disabling-server-charts)
* [Defense Unicorns os prep script for rke2](https://github.com/defenseunicorns/uds-rke2-image-builder/blob/main/packer/scripts/os-prep.sh)
mjnagel marked this conversation as resolved.
Show resolved Hide resolved


### K3S
---
* [OS requirements](https://docs.k3s.io/installation/requirements#operating-systems)



### UDS Core components
---
#### UDS Operator
#### Istio
* [Platform requirements](https://istio.io/latest/docs/ops/deployment/platform-requirements/)
#### Keycloak
* [Configuration guide](https://www.keycloak.org/keycloak-benchmark/kubernetes-guide/latest/)
#### Neuvector
mjnagel marked this conversation as resolved.
Show resolved Hide resolved
#### Loki
#### Prometheus
#### Promtail
mjnagel marked this conversation as resolved.
Show resolved Hide resolved
#### Grafana
#### Authservice
#### Velero
mjnagel marked this conversation as resolved.
Show resolved Hide resolved
#### Metrics Server
* Optional component and can be added if needed. Most of the provided managed clsuters will provide you a metric server.
lemonprogis marked this conversation as resolved.
Show resolved Hide resolved
```yaml
...
- name: uds-core
repository: ghcr.io/defenseunicorns/packages/private/uds/core
ref: 0.25.2-unicorn
optionalComponents:
- metrics-server
...
```