Skip to content

Commit

Permalink
docs: describe cntlm setup
Browse files Browse the repository at this point in the history
  • Loading branch information
oyo committed Oct 22, 2024
1 parent c66e7a9 commit 76a176e
Showing 1 changed file with 68 additions and 24 deletions.
92 changes: 68 additions & 24 deletions charts/localdev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,34 @@ This chart also sets up an additional [postgresql](https://artifacthub.io/packag

For detailed information about the default configuration values, please have a look at the [Values table](#values) and/or [Values file](./values.yaml).

- [Usage](#usage)
- [Cluster setup](#cluster-setup)
- [Linux and Mac](#cluster-setup-linux-and-mac)
- [Cluster Setup Windows](#cluster-setup-windows)
- [Minikube](#minikube)
- [Docker Desktop integrated Kubernetes](#docker-desktop-integrated-kubernetes)
- [Network Setup](#network-setup)
- [Minikube Addons](#minikube-addons)
- [Docker Desktop integrated Kubernetes Ingress Controller](#docker-desktop-integrated-kubernetes-ingress-controller)
- [Linux and Mac](#network-setup-on-linux-and-mac)
- [Additional Network Setup for Mac](#additional-network-setup-for-mac)
- [Windows/wsl2 with NTLM-proxy](#network-setup-on-windowswsl2-with-ntlm-proxy)
- [px-proxy](#px-proxy)
- [DNS-resolution in Windows](#dns-resolution-in-windows)
- [DNS-resolution in wsl2](#dns-resolution-in-wsl2)
- [Proxy-setup in wsl2](#proxy-setup-in-wsl2)
- [Install](#install)
- [Use released chart](#use-released-chart)
- [Use local repository](#use-local-repository)
- [Perform first login](#perform-first-login)
- [Database Access](#database-access)
- [Keycloak Admin Console](#keycloak-admin-console)
- [Uninstall](#uninstall)
- [Prepare self-signed TLS setup (Optional)](#prepare-self-signed-tls-setup-optional)
- [Setup of CX Portal \& IAM for local development](#setup-of-cx-portal--iam-for-local-development)
- [Usage](#usage)
- [Cluster Setup](#cluster-setup)
- [Cluster Setup Linux and Mac](#cluster-setup-linux-and-mac)
- [Cluster Setup Windows](#cluster-setup-windows)
- [Minikube](#minikube)
- [Docker Desktop integrated Kubernetes](#docker-desktop-integrated-kubernetes)
- [Network Setup](#network-setup)
- [Minikube Addons](#minikube-addons)
- [Docker Desktop integrated Kubernetes Ingress Controller](#docker-desktop-integrated-kubernetes-ingress-controller)
- [Network Setup on Linux and Mac](#network-setup-on-linux-and-mac)
- [Additional Network Setup for Mac](#additional-network-setup-for-mac)
- [Setup cntlm proxy](#setup-cntlm-proxy)
- [Network Setup on Windows/wsl2 with NTLM-proxy](#network-setup-on-windowswsl2-with-ntlm-proxy)
- [px-proxy](#px-proxy)
- [DNS-resolution in Windows](#dns-resolution-in-windows)
- [DNS-resolution in wsl2](#dns-resolution-in-wsl2)
- [Proxy-setup in wsl2](#proxy-setup-in-wsl2)
- [Install](#install)
- [Use released chart](#use-released-chart)
- [Use local repository](#use-local-repository)
- [Perform first login](#perform-first-login)
- [Database Access](#database-access)
- [Keycloak Admin Console](#keycloak-admin-console)
- [Uninstall](#uninstall)
- [Prepare self-signed TLS setup (Optional)](#prepare-self-signed-tls-setup-optional)
- [Requirements](#requirements)
- [Values](#values)

## Usage

Expand Down Expand Up @@ -170,6 +174,46 @@ If you're having issues with getting 'Docker Mac Net Connect' to work, we recomm

The tool is necessary due to [#7332](https://github.com/kubernetes/minikube/issues/7332).

#### Setup cntlm proxy

Follow these steps if you are behind a firewall and have only access to the internet from behind an authenticating corporate NTLM http proxy.

```bash
$ brew install cntlm
```

Locate and edit the config file to set your proxy and authentication credentials ( `vi ~/.brew/etc/cntlm.conf` )
```
Username your_userid
Domain your_domain
Password your_ntlm_proxy_password
Proxy your.corporate.proxy.host:8080
# include domain .tx.test and minikube ip address
NoProxy localhost, 127.0.0.1, 192.168.49.2, *.tx.test, *.other.domains
Listen 3128
```

(Re-)start cntlm
```
$ pkill -x 'cntlm'
$ cntlm
```

Locate and edit the settings file for your shell to set env vars ( `vi ~/.zshrc` )
```
export http_proxy=http://localhost:3128
export https_proxy=http://localhost:3128
# include domain .tx.test and minikube ip address
export no_proxy=localhost,127.0.0.1,192.168.49.2,.tx.test,.other.domains
```

Save and apply your settings and test internet access
```
$ source ~/.zshrc
$ curl https://github.com/ -Is | grep server
server: GitHub.com
```

### Network Setup on Windows/wsl2 with NTLM-proxy

Configure wsl networking, assign additional fixed IP addresses to both wsl2 and windows, the wsl2-ip-address will then be used as cluster-ip-address. Do **not** use 127.0.0.1 as Cluster IP, as this causes issues when services try to access other services via the ingress from within the cluster.
Expand Down

0 comments on commit 76a176e

Please sign in to comment.