Skip to content

helm: add chart example values#19397

Closed
hugoShaka wants to merge 1 commit intomasterfrom
hugo/chart-example-values
Closed

helm: add chart example values#19397
hugoShaka wants to merge 1 commit intomasterfrom
hugo/chart-example-values

Conversation

@hugoShaka
Copy link
Copy Markdown
Contributor

Part of RFD-0096

This PR adds value examples for various setups. The goal is to show users how the chart can be used.

@hugoShaka hugoShaka changed the base branch from master to hugo/chart-split-proxy-auth December 15, 2022 14:27
Copy link
Copy Markdown
Contributor

@webvictim webvictim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have an extra example file showing how to configure ACM?

annotations:
  service:
    service.beta.kubernetes.io/aws-load-balancer-ssl-cert: "arn:aws:acm:us-east-1:1234567890:certificate/12345678-43c7-4dd1-a2f6-c495b91ebece"
    service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443"
    service.beta.kubernetes.io/aws-load-balancer-backend-protocol: ssl

Maybe with a commented out service.beta.kubernetes.io/aws-load-balancer-scheme: "internal" for an extra example of how to deploy an internal LB?

Comment on lines +7 to +12
auth_service:
authentication:
type: local
second_factor: on
webauthn:
rp_id: teleport.example.com
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess as part of the revamp we're no longer going to just let people set authentication.secondFactor: on in the values and write this config for them automatically? I can see this being jarring for people who have an existing setup and are upgrading.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, the old version is still working. I just tried to emphasize the config passthrough whenever possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, I wasn't 100% sure. Great news!

@@ -0,0 +1,36 @@
# This example shows how to configure Teleport auth pods to authenticate to AWS by assuming an IAM role
# instead of inheriting ambiant credentials from the EC2 node or relying on a service account key.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# instead of inheriting ambiant credentials from the EC2 node or relying on a service account key.
# instead of inheriting ambient credentials from the EC2 node or relying on a service account key.

Comment on lines +1 to +3
# EKS in-tree LoadBalancer usage is discouraged by AWS but remains the easiest and most used
# way to create a LoadBalancer on an EKS cluster as it is working by default and does not
# require the cluster administrator to install and maintain additional components.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still mapped to an ELB (i.e. classic LB) by default when running in Kubernetes, right?

I kinda think we should just remove all examples of doing this as ELBs are so old...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The chart will put the annotation asking for an NLB when running in chartMode: aws.

Comment on lines +7 to +23
auth:
resources:
requests:
cpu: "3"
memory: "6GiB"
limits:
cpu: "3"
memory: "6GiB"

proxy:
resources:
requests:
cpu: "1"
memory: "4GiB"
limits:
cpu: "1"
memory: "4GiB"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
auth:
resources:
requests:
cpu: "3"
memory: "6GiB"
limits:
cpu: "3"
memory: "6GiB"
proxy:
resources:
requests:
cpu: "1"
memory: "4GiB"
limits:
cpu: "1"
memory: "4GiB"
auth:
resources:
requests:
cpu: "25m"
memory: "25Mi"
limits:
cpu: "4"
memory: "4Gi"
proxy:
resources:
requests:
cpu: "25m"
memory: "25Mi"
limits:
cpu: "4"
memory: "4Gi"

These match the limits we set by default for Teleport Cloud, so might be a little more useful if people just copy/paste them blindly...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mismatched memory requests and limits 😭

Comment on lines +22 to +24
type: etcd
peers: [ "https://etcd-0.etcd-headless.teleport.svc.cluster.local:2379", "https://etcd-1.etcd-headless.teleport.svc.cluster.local:2379", "https://etcd-2.etcd-headless.teleport.svc.cluster.local:2379" ]
prefix: /teleport/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be a bit more readable like this? I don't know which I prefer 🤷‍♂️

Suggested change
type: etcd
peers: [ "https://etcd-0.etcd-headless.teleport.svc.cluster.local:2379", "https://etcd-1.etcd-headless.teleport.svc.cluster.local:2379", "https://etcd-2.etcd-headless.teleport.svc.cluster.local:2379" ]
prefix: /teleport/
type: etcd
peers:
- "https://etcd-0.etcd-headless.teleport.svc.cluster.local:2379"
- "https://etcd-1.etcd-headless.teleport.svc.cluster.local:2379"
- "https://etcd-2.etcd-headless.teleport.svc.cluster.local:2379"
prefix: /teleport/

Copy link
Copy Markdown
Contributor

@marcoandredinis marcoandredinis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples look good
Did we try all of them?

@hugoShaka
Copy link
Copy Markdown
Contributor Author

Did we try all of them?

Not yet, I'm waiting for the main PR merge and SEs feedback to run all those examples. For now, the config is just copied from GitHub discussions.

# AWS LoadBalancer Controller is the AWS recommended way to create AWS LoadBalancer resources
# sending traffic to an EKS cluster. However, this requires cluster administrators to install
# and manage the controller.
# See
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove extra See?

@hugoShaka hugoShaka force-pushed the hugo/chart-split-proxy-auth branch from c83b7d1 to 3ec9f8f Compare January 5, 2023 21:44
Base automatically changed from hugo/chart-split-proxy-auth to master January 13, 2023 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants