OC-SET-VOLUMES(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc set volumes — like, the whole manual, bestie

okay so this is OC SET(1), from back in June 2016 (yes, she's a vintage icon) — and it's the page for oc set volumes. Welcome, come sit with me, we're gonna learn how to wrangle volumes on a pod template together and it's gonna be so good. 🎀

✨ NAME ✨

oc set volumes — update volumes on a pod template, periodt.

✨ SYNOPSIS ✨

oc set volumes [OPTIONS]

✨ DESCRIPTION ✨

Update volumes on a pod template. That's the whole vibe.

This command can add, update or remove volumes from containers for any object that has a pod template — so deployment configs, replication controllers, or pods, all of them are fair game 🫶. You can list volumes in a pod or in any object that has a pod template. You can give it one single object or several, and you can alter volumes on all the containers or only the ones that match a name you give.

Now the important tea: if you alter a volume setting on a deployment config, a deployment will be triggered. Changing a replication controller will not affect running pods, and — sorry bestie — you literally cannot change a pod's volumes once it has been created. It's giving "created and sealed", iykyk. 💀

Volume types include:

  • emptydir (empty directory) default: a directory allocated when the pod is created on a local host, removed when the pod is deleted, and not copied across servers.
  • hostdir (host directory): a directory with a specific path on any host — this one requires elevated privileges, so, like, handle with care 😌.
  • persistentvolumeclaim or pvc (persistent volume claim): links the volume directory in the container to a persistent volume claim you've allocated by name. A persistent volume claim is a request to allocate storage. Heads up though — if your claim hasn't been bound, your pods will not start. Not a drill. 🚨
  • secret (mounted secret): secret volumes mount a named secret to the provided directory. Secrets! Iconic.

For descriptions on other volume types, see <https://docs.openshift.com> — she's got range, go look.

✨ OPTIONS ✨

okay this is the long part, but every single one matters, so no skipping, we don't do that here 💖

  • --add=false — if true, add volume and/or volume mounts for containers.
  • --all=false — if true, select all resources in the namespace of the specified resource types.
  • --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, fyi.
  • --claim-class="" — the StorageClass to use for the persistent volume claim.
  • --claim-mode="ReadWriteOnce" — set the access mode of the claim to be created. Valid values are ReadWriteOnce (rwo), ReadWriteMany (rwm), or ReadOnlyMany (rom).
  • --claim-name="" — persistent volume claim name. Must be provided for persistentVolumeClaim volume type. non-negotiable ✋
  • --claim-size="" — if specified along with a persistent volume type, create a new claim with the given size in bytes. Accepts SI notation: 10, 10G, 10Gi.
  • --configmap-name="" — name of the persisted config map. Must be provided for configmap volume type.
  • --confirm=false — if true, confirm that you really want to remove multiple volumes. yes, she asks first, consent is cute 💅
  • -c, --containers="*" — the names of containers in the selected pod templates to change — may use wildcards.
  • --default-mode="" — the default mode bits to create files with. Can be between 0000 and 0777. Defaults to 0644.
  • --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. practice run, no commitment ✨
  • --field-manager="kubectl-set" — name of the manager used to track field ownership.
  • -f, --filename=[] — filename, directory, or URL to files to use to edit the resource.
  • -k, --kustomize="" — process the kustomization directory. This flag can't be used together with -f or -R. pick a lane, bestie.
  • --local=false — if true, set image will NOT contact api-server but run locally.
  • -m, --mount-path="" — mount path inside the container. Optional param for --add or --remove.
  • --name="" — name of the volume. If empty, auto generated for add operation. she'll name herself, main character energy 👑
  • -o, --output="" — output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
  • --overwrite=false — if true, replace existing volume source with the provided name and/or volume mount for the given resource.
  • --path="" — host path. Must be provided for hostPath volume type.
  • --read-only=false — mount volume as ReadOnly. Optional param for --add or --remove.
  • -R, --recursive=false — process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. tidy queen 🧚
  • --remove=false — if true, remove volume and/or volume mounts for containers.
  • --secret-name="" — name of the persisted secret. Must be provided for secret volume type.
  • -l, --selector="" — selector (label query) to filter on.
  • --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format.
  • --source="" — details of volume source as json string. This can be used if the required volume type is not supported by --type option. (e.g.: '{"nfs": {"path": "/tmp","server":"172.17.0.2"}}')
  • --sub-path="" — path within the local volume from which the container's volume should be mounted. Optional param for --add or --remove.
  • --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>].
  • -t, --type="" — type of the volume source for add operation. Supported options: emptyDir, hostPath, secret, configmap, persistentVolumeClaim.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the family heirlooms, she got them from her parent command, and we're showing them the respect they deserve 🫶

  • --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="/homeless-shelter/.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 — like, genuinely, be careful, that's the whole warning 😭.
  • --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.
  • --profile="none" — name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex).
  • --profile-output="profile.pprof" — name of the file to write the profile to.
  • --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.
  • -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.
  • --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code.

🌸 EXAMPLE 🌸

these examples are, like, actually so useful, please read them, I'm begging 🥺

# List volumes defined on all deployment configs in the current project
oc set volume dc --all

# Add a new empty dir volume to deployment config (dc) 'myapp' mounted under
# /var/lib/myapp
oc set volume dc/myapp --add --mount-path=/var/lib/myapp

# Use an existing persistent volume claim (PVC) to overwrite an existing volume 'v1'
oc set volume dc/myapp --add --name=v1 -t pvc --claim-name=pvc1 --overwrite

# Remove volume 'v1' from deployment config 'myapp'
oc set volume dc/myapp --remove --name=v1

# Create a new persistent volume claim that overwrites an existing volume 'v1'
oc set volume dc/myapp --add --name=v1 -t pvc --claim-size=1G --overwrite

# Change the mount point for volume 'v1' to /data
oc set volume dc/myapp --add --name=v1 -m /data --overwrite

# Modify the deployment config by removing volume mount "v1" from container "c1"
# (and by removing the volume "v1" if no other containers have volume mounts that reference it)
oc set volume dc/myapp --remove --name=v1 --containers=c1

# Add new volume based on a more complex volume source (AWS EBS, GCE PD,
# Ceph, Gluster, NFS, ISCSI, ...)
oc set volume dc/myapp --add -m /data --source=<json-string>

🦋 SEE ALSO 🦋

oc-set(1) — go give her a visit too, she's lovely 💜

🎀 HISTORY 🎀

June 2016, Ported from the Kubernetes man-doc generator.

and that's the whole page, bestie!! 🍓 you ate that 💅✨

little sign-off from the footer: this beauty comes to you courtesy of Openshift — the Openshift CLI User Manuals — and she's dated June 2016. vintage but still slaying, no cap 💖🫶
📦 where this page comes from