Skip to content

changes to the kubernetes docs #7497

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.

Sign up for GitHub

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

Draft
wants to merge 8 commits into
base: dev
Choose a base branch
from
Draft

changes to the kubernetes docs #7497

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
20aaf5a
draft: changes to the kubernetes docs
lleadbet May 14, 2025
beade6d
add sidebar
lleadbet May 14, 2025
065bab5
Merge branch 'dev' into docs/deployment-adjustments
lleadbet May 15, 2025
1685717
Update docs/source/_sidebar.yaml
lleadbet May 19, 2025
231486b
move k8s docs
Meschreiber May 19, 2025
37cbcf7
Delete duplicates
Meschreiber May 19, 2025
e990d23
pathing updates
lleadbet May 20, 2025
45b4916
Update docs/source/routing/self-hosted/containerization/kubernetes/qu…
lleadbet May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 44 additions & 20 deletions docs/shared/helm-show-router-output.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,30 @@
```yaml
Pulled: ghcr.io/apollographql/helm-charts/router:1.31.0
Digest: sha256:26fbe98268456935cac5b51d44257bf96c02ee919fde8d47a06602ce2cda66a3
# Default values for router.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

replicaCount: 1

# -- See https://www.apollographql.com/docs/router/configuration/overview/#yaml-config-file for yaml structure
# -- See https://www.apollographql.com/docs/graphos/reference/router/configuration#yaml-config-file for yaml structure
router:
configuration:
supergraph: # HTTP server
listen: 0.0.0.0:80
supergraph:
listen: 0.0.0.0:4000
health_check:
listen: 0.0.0.0:8088
telemetry:
metrics:
prometheus:
enabled: false
listen: 0.0.0.0:9090
path: "/metrics"

args:
- --hot-reload
- --hot-reload

managedFederation:
# -- If using managed federation, the graph API key to identify router to Studio
apiKey:
# -- If using managed federation, use an existing secret which stores the graph API key instead of creating a new one.
# -- If using managed federation, use existing Secret which stores the graph API key instead of creating a new one.
# If set along `managedFederation.apiKey`, a secret with the graph API key will be created using this parameter as name
existingSecret:
# -- If using managed federation, the name of the key within the existing Secret which stores the graph API key.
# If set along `managedFederation.apiKey`, a secret with the graph API key will be created using this parameter as key, defaults to using a key of `managedFederationApiKey`
existingSecretKeyRefKey:
# -- If using managed federation, the variant of which graph to use
graphRef: ""

Expand All @@ -46,8 +41,8 @@ supergraphFile:
# value: debug
#
extraEnvVars: []
extraEnvVarsCM: ''
extraEnvVarsSecret: ''
extraEnvVarsCM: ""
extraEnvVarsSecret: ""

# An array of extra VolumeMounts
# Example:
Expand All @@ -74,7 +69,7 @@ image:

containerPorts:
# -- If you override the port in `router.configuration.server.listen` then make sure to match the listen port here
http: 80
http: 4000
# -- For exposing the metrics port when running a serviceMonitor for example
metrics: 9090
# -- For exposing the health check endpoint
Expand Down Expand Up @@ -127,10 +122,12 @@ serviceAccount:

podAnnotations: {}

podSecurityContext: {}
podSecurityContext:
{}
# fsGroup: 2000

securityContext: {}
securityContext:
{}
# capabilities:
# drop:
# - ALL
Expand All @@ -142,6 +139,7 @@ service:
type: ClusterIP
port: 80
annotations: {}
targetport: http
Copy link
Contributor

Choose a reason for hiding this comment

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

Without working this through totally, I think the ports are no longer wired up correctly. Have you tested that this works? I feel like the targetport should now be 4000. I could be wrong, I just wired it up in my head...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The above was pulled from helm show values oci://ghcr.io/apollographql/helm-charts/router, but it is targeting port 4000 on the router pods. we have:

containerPorts:
  # -- If you override the port in `router.configuration.server.listen` then make sure to match the listen port here
  http: 4000

so we are naming the server port as http which means this mapping will just be port 4000 - even if the name is maybe a misnomer.


serviceMonitor:
enabled: false
Expand All @@ -166,7 +164,12 @@ ingress:
virtualservice:
enabled: false
# namespace: ""
# gatewayName: ""
# gatewayName: "" # Deprecated in favor of gatewayNames
# gatewayNames: []
# - "gateway-1"
# - "gateway-2"
# Hosts: "" # configurable but will default to '*'
# - somehost.domain.com
# http:
# main:
# # set enabled to true to add
Expand Down Expand Up @@ -194,7 +197,8 @@ serviceentry:
# a list of external hosts you want to be able to make https calls to
# - api.example.com

resources: {}
resources:
{}
# We usually recommend not to specify default resources and to leave this as a conscious
# choice for the user. This also increases chances charts run on environments with little
# resources, such as Minikube. If you do want to specify resources, uncomment the following
Expand All @@ -212,6 +216,20 @@ autoscaling:
maxReplicas: 100
targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80
#
# Specify container-specific HPA scaling targets
# Only available in 1.27+ (https://kubernetes.io/blog/2023/05/02/hpa-container-resource-metric/)
# containerBased:
# - name: <container name>
# type: cpu
# targetUtilizationPercentage: 75

# -- Sets the [rolling update strategy parameters](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#rolling-update-deployment). Can take absolute values or % values.
rollingUpdate:
{}
# Defaults if not set are:
# maxUnavailable: 25%
# maxSurge: 25%

nodeSelector: {}

Expand All @@ -235,4 +253,10 @@ probes:
# -- Configure liveness probe
liveness:
initialDelaySeconds: 0

# -- Sets the [topology spread constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) for Deployment pods
topologySpreadConstraints: []

# -- Sets the restart policy of pods
restartPolicy: Always
```
Loading