stackabletech / stackabletech/stackablectl

chore: Move OCI code into a helm module to hide implementation details.

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
10
Forks
5
Avg merge
4h 41m
Merged PRs (30d)
4

Description

We currently have helm.rs and oci.rs in stackable-cockpit. In the future we want to consolidate all repo-relevant code into a single module so that calling functions do not need to know about the underlying detail. This will become more relevant when:

  • external dependencies no longer exclusively use repositories (as is currently the case for e.g. demos)
  • other chart types such as .tgz archives are considered

N.B.

From the helm online help, installations can use:

  1. By chart reference: helm install mymaria example/mariadb
  2. By path to a packaged chart: helm install mynginx ./nginx-1.2.3.tgz
  3. By path to an unpacked chart directory: helm install mynginx ./nginx
  4. By absolute URL: helm install mynginx https://example.com/charts/nginx-1.2.3.tgz
  5. By chart reference and repo url: helm install --repo https://example.com/charts/ mynginx nginx
  6. By OCI registries: helm install mynginx --version 1.2.3 oci://example.com/charts/nginx

We currently implement 1, 5, 6.

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.

Research direction

Start by reading helm.rs and oci.rs in stackable-cockpit to understand how the current repository and OCI implementations are exposed to callers. Move the OCI-specific code behind the helm module so callers no longer depend on its implementation details, while preserving the currently supported installation methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, rust
Domain
cli, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.