KUBERNETES(1)(kubernetes)

✨ KUBERNETES(1)(kubernetes) β€” the kubectl create ingress glow-up ✨

okay bestie, sit down, hydrate, because we're doing kubectl from the kubernetes manual and honestly? it's giving cluster admin main character energy. πŸ’…


🌸 NAME 🌸

kubectl create ingress β€” Create an ingress with the specified name


πŸ¦‹ SYNOPSIS πŸ¦‹

kubectl create ingress [OPTIONS]

πŸ’– DESCRIPTION πŸ’–

Create an ingress with the specified name. that's it, that's the whole vibe. you name it, it makes it. iconic behavior fr fr. ✨


πŸŽ€ OPTIONS πŸŽ€

  • --allow-missing-template-keys=true β€” If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (so like, the template goes "where's the key bestie" and you're like "it's fine, let it go" 🫢)
  • --annotation=[] β€” Annotation to insert in the ingress object, in the format annotation=value
  • --class="" β€” Ingress Class to be used
  • --default-backend="" β€” Default service for backend, in format of svcname:port
  • --dry-run="none" β€” Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. (a little preview moment, no commitment πŸ”₯)
  • --field-manager="kubectl-create" β€” Name of the manager used to track field ownership.
  • -o, --output="" β€” Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
  • --rule=[] β€” Rule in format host/path=service:port[,tls=secretname]. Paths containing the leading character '*' are considered pathType=Prefix. tls argument is optional. (the * is doing SO much work here, no cap)
  • --save-config=false β€” If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
  • --show-managed-fields=false β€” If true, keep the managedFields when printing objects in JSON or YAML format.
  • --template="" β€” Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
  • --validate="strict" β€” Must be one of: strict (or true), warn, ignore (or false). "true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields. (strict is the girl who checks everything twice, ignore is the girl who simply does not look πŸ’€)

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the heirlooms, the hand-me-downs, the family jewels of every kubectl command. you get them for free, you did not ask, and yet. πŸ‘‘

  • --as="" β€” Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
  • --as-group=[] β€” Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  • --as-uid="" β€” UID to impersonate for the operation.
  • --as-user-extra=[] β€” User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
  • --cache-dir="/home/username/.kube/cache" β€” Default cache directory
  • --certificate-authority="" β€” Path to a cert file for the certificate authority
  • --client-certificate="" β€” Path to a client certificate file for TLS
  • --client-key="" β€” Path to a client key file for TLS
  • --cluster="" β€” The name of the kubeconfig cluster to use
  • --context="" β€” The name of the kubeconfig context to use
  • --disable-compression=false β€” If true, opt-out of response compression for all requests to the server
  • --insecure-skip-tls-verify=false β€” If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure ⚠️
  • --kubeconfig="" β€” Path to the kubeconfig file to use for CLI requests.
  • --kuberc="" β€” Path to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
  • --match-server-version=false β€” Require server version to match client version
  • -n, --namespace="" β€” If present, the namespace scope for this CLI request
  • --password="" β€” Password for basic authentication to the API server
  • --profile="none" β€” Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace)
  • --profile-output="profile.pprof" β€” Name of the file to write the profile to
  • --proxy-url="" β€” Proxy URL to use for requests to the API server
  • --request-timeout="0" β€” The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (zero = forever, we stan a patient queen πŸ•°οΈ)
  • -s, --server="" β€” The address and port of the Kubernetes API server
  • --tls-server-name="" β€” Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
  • --token="" β€” Bearer token for authentication to the API server
  • --user="" β€” The name of the kubeconfig user to use
  • --username="" β€” Username for basic authentication to the API server
  • --version=false β€” --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
  • --warnings-as-errors=false β€” Treat warnings received from the server as errors and exit with a non-zero exit code
⚠️ real talk: that --insecure-skip-tls-verify one is not the moment. it skips certificate validity checking and makes your HTTPS connections insecure. dramatic on purpose, because it IS a big deal. 🚨

🌟 EXAMPLE 🌟

the examples section, aka the tutorial era. copy these EXACTLY, don't freestyle:

# Create a single ingress called 'simple' that directs requests to foo.com/bar to svc
# svc1:8080 with a TLS secret "my-cert"
kubectl create ingress simple --rule="foo.com/bar=svc1:8080,tls=my-cert"

# Create a catch all ingress of "/path" pointing to service svc:port and Ingress Class as "otheringress"
kubectl create ingress catch-all --class=otheringress --rule="/path=svc:port"

# Create an ingress with two annotations: ingress.annotation1 and ingress.annotations2
kubectl create ingress annotated --class=default --rule="foo.com/bar=svc:port" \
--annotation ingress.annotation1=foo \
--annotation ingress.annotation2=bla

# Create an ingress with the same host and multiple paths
kubectl create ingress multipath --class=default \
--rule="foo.com/=svc:port" \
--rule="foo.com/admin/=svcadmin:portadmin"

# Create an ingress with multiple hosts and the pathType as Prefix
kubectl create ingress ingress1 --class=default \
--rule="foo.com/path*=svc:8080" \
--rule="bar.com/admin*=svc2:http"

# Create an ingress with TLS enabled using the default ingress certificate and different path types
kubectl create ingress ingtls --class=default \
--rule="foo.com/=svc:https,tls" \
--rule="foo.com/path/subpath*=othersvc:8080"

# Create an ingress with TLS enabled using a specific secret and pathType as Prefix
kubectl create ingress ingsecret --class=default \
--rule="foo.com/*=svc:8080,tls=secret1"

# Create an ingress with a default backend
kubectl create ingress ingdefault --class=default \
--default-backend=defaultsvc:http \
--rule="foo.com/*=svc:8080,tls=secret1"

πŸ‘€ SEE ALSO πŸ‘€

(go read it, it's the parent, it raised this command πŸ₯Ή)


πŸ“œ HISTORY πŸ“œ

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! (the "hopefully" is sending me 😭)


and that's the whole page bestie. every flag, every default, every rule format, untouched, unbothered, exactly as the source material wrote it. mwah. πŸ’‹

sign-off time: this lil manual page lives under the Manuals / User corner of the KUBERNETES(1)(kubernetes) world, and it's dated Jan 2015, authored by Eric Paris. periodt. πŸŽ€βœ¨πŸ¦‹

πŸ“¦ where this page comes from