Skip to content

Commit 940030a

Browse files
Copilotillume
andcommitted
Mention multiple cloud vendors and fix if-else chain
- Update README and docs to mention AWS EKS, Azure AKS, and Google GKE - Change example section title to "Managed Kubernetes" instead of just "EKS" - Add note that configuration works with AKS and GKE - Fix ifElseChain lint suggestion by using switch statement - All linter warnings addressed Co-authored-by: illume <9541+illume@users.noreply.github.com>
1 parent 84a51f7 commit 940030a

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

backend/cmd/headlamp_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1752,11 +1752,12 @@ func TestCustomAPIServerEndpoint(t *testing.T) {
17521752
t.Fatal("Expected error with http:// URL, but got nil")
17531753
}
17541754

1755-
if strings.Contains(err.Error(), "must be a full https:// URL") {
1755+
switch {
1756+
case strings.Contains(err.Error(), "must be a full https:// URL"):
17561757
t.Logf("https validation working correctly: %v", err)
1757-
} else if strings.Contains(err.Error(), "unable to load in-cluster configuration") {
1758+
case strings.Contains(err.Error(), "unable to load in-cluster configuration"):
17581759
t.Skip("not running in cluster environment, cannot test full functionality")
1759-
} else {
1760+
default:
17601761
t.Fatalf("unexpected error: %v", err)
17611762
}
17621763

charts/headlamp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ $ helm install my-headlamp headlamp/headlamp \
6363
--set config.apiServerEndpoint=https://kube-oidc-proxy.example.com:443
6464
```
6565

66-
This is particularly useful with managed Kubernetes clusters (like EKS) when using [kube-oidc-proxy](https://github.com/jetstack/kube-oidc-proxy) to handle OIDC authentication.
66+
This is particularly useful with managed Kubernetes clusters (like AWS EKS, Azure AKS, or Google GKE) when using [kube-oidc-proxy](https://github.com/jetstack/kube-oidc-proxy) to handle OIDC authentication with private identity providers.
6767

6868
## Configuration
6969

docs/installation/in-cluster/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ By default, when running in-cluster, Headlamp automatically detects and connects
5555

5656
This feature is particularly useful for:
5757

58-
- **OIDC Authentication with Private Endpoints**: When using managed Kubernetes services (like AWS EKS) with OIDC authentication where the identity provider is on a private endpoint, you can use [kube-oidc-proxy](https://github.com/jetstack/kube-oidc-proxy) to handle authentication requests.
58+
- **OIDC Authentication with Private Endpoints**: When using managed Kubernetes services (like AWS EKS, Azure AKS, or Google GKE) with OIDC authentication where the identity provider is on a private endpoint, you can use [kube-oidc-proxy](https://github.com/jetstack/kube-oidc-proxy) to handle authentication requests.
5959
- **API Gateway or Proxy Requirements**: When your cluster requires all API traffic to go through a specific gateway or proxy for security, logging, or compliance reasons.
6060
- **Multi-cluster Authentication**: When using a centralized authentication proxy across multiple clusters.
6161

@@ -83,9 +83,11 @@ You can also configure it using environment variables or command-line flags:
8383

8484
**Note**: These options are only used when running Headlamp with in-cluster mode enabled (`--in-cluster` flag or `config.inCluster: true` in Helm values).
8585

86-
### Example: Using with kube-oidc-proxy on EKS
86+
### Example: Using with kube-oidc-proxy on Managed Kubernetes
8787

88-
When using Amazon EKS with a private OIDC issuer, you can deploy kube-oidc-proxy to handle authentication and configure Headlamp to route requests through it:
88+
When using managed Kubernetes services (AWS EKS, Azure AKS, Google GKE) with a private OIDC issuer, you can deploy kube-oidc-proxy to handle authentication and configure Headlamp to route requests through it.
89+
90+
**Example with AWS EKS:**
8991

9092
```bash
9193
# Install kube-oidc-proxy (example)
@@ -100,7 +102,9 @@ helm install my-headlamp headlamp/headlamp \
100102
--set config.oidc.issuerURL=https://your-private-issuer.example.com
101103
```
102104

103-
For more information about using kube-oidc-proxy with EKS, see the [AWS blog post on consistent OIDC authentication](https://aws.amazon.com/blogs/opensource/consistent-oidc-authentication-across-multiple-eks-clusters-using-kube-oidc-proxy/).
105+
For more information about using kube-oidc-proxy with managed Kubernetes clusters, see:
106+
- AWS EKS: [Consistent OIDC authentication across multiple EKS clusters](https://aws.amazon.com/blogs/opensource/consistent-oidc-authentication-across-multiple-eks-clusters-using-kube-oidc-proxy/)
107+
- The configuration works similarly with Azure AKS and Google GKE when using private OIDC providers
104108

105109
### Testing the Custom API Server Endpoint
106110

0 commit comments

Comments
 (0)