README.md

drunk-nginx-proxy Chart

This Helm chart facilitates the deployment of an nginx-proxy that acts as a forward proxy. The proxy is designed to enable internal services within your Kubernetes cluster to securely communicate with external services using mutual TLS (mTLS) authentication. By leveraging nginx's robust capabilities, the chart provides configuration options to specify target hosts, paths, and the necessary mTLS credentials. This forward proxy setup not only ensures encrypted communication but also validates both parties' authenticity, providing an additional layer of security for your webhooks and web applications.

Table of Contents

• drunk-nginx-proxy Chart
  • Table of Contents
  • Introduction
  • Prerequisites
  • Installation
  • Parameters
  • Usage
  • Contributing
  • License
    • Thanks

Introduction

This Helm chart deploys the nginx-proxy.

Prerequisites

• Kubernetes 1.19+
• Helm 3.0+
• A running Kubernetes cluster
• kubectl configured to access your Kubernetes cluster

Installation

To install the chart with the release name drunk-nginx-proxy, follow these steps:

1. Add the Helm repository (if needed):

   helm repo add drunk-nginx-proxy https://baoduy.github.io/drunk.charts/drunk-nginx-proxy
   helm repo update

2. Install the chart:

   helm install drunk-nginx-proxy drunk-nginx-proxy/drunk-nginx-proxy

Parameters

The following table lists the configurable parameters of the drunk-nginx-proxy chart and their default values in values.test.yaml.

Parameter	Description	Example	Type
proxies.[name].enabled	Enable proxy	true	boolean
proxies.[name].ingressHost	Host ingress	localhost	string
proxies.[name].ingressPath	Path ingress	/webhook/?(.*)	string
proxies.[name].ingressClassName	The nginx ClassName	nginx	string
proxies.[name].ingressTlsSecret	The secret name of Tls cert If running ingress under HTTPS	tls-secret-name	string
proxies.[name].targetHost	Target IP address	webhook.site	string
proxies.[name].targetPort	Target port	webhook.site	string
proxies.[name].targetMTlsCert.ca	CA certificate backend TLS	123	string
proxies.[name].targetMTlsCert.crt	Certificate backend TLS	444	string
proxies.[name].targetMTlsCert.key	private Key backend TLS	555	string

Usage

Please refer the values.test.yaml for details.

Contributing

Contributions are welcome!. For any questions or issues, please open an issue in the project's GitHub repository.

License

This project is licensed under the MIT License.

Thanks

Steven Hoang