Add a generic section on how to mount extra data into our images

Open
#779 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
kubernetes
Domain
documentation

Research direction

Locate the appropriate shared documentation section and review how existing operator pages describe runtime data and volume options. Add a structured section covering OCI artifacts, copying to a persistent volume, an init container, and gitsync, with pros and cons plus the warning against putting binary data in ConfigMaps or Secrets.

Written by the indexing model from the issue text.

Description

We regularly get questions about how to add binaries or other files into our images at runtime.
There are a few options that we recommend and it differs per operator because not all of them support extra_volumes, but we never wrote this down in a structured fashion and picked a recommended option.

Lets add a section to the docs and spell out the main three or four options along with pros and cons and also mention what not to do.

Possible ways:

  • mount OCI artifact
  • copy to PV and mount that
  • init container to download and copy
  • gitsync

Not recommended:

  • stick binary data into a ConfigMap or Secret
Dominant language
CSS
Stars
13
Forks
14
Avg merge
4d 8h
Merged PRs (30d)
10

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stackabletech/documentation

All issues in stackabletech/documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.