stackabletech / stackabletech/documentation
Create ADR on options for an operator to manage stackable components
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
Description
This was triggered to a certain extent by a discussion around OpenShift and how we cannot currently certify the secret and listener operator, because these need to be deployed a a DaemonSet, which is not supported by Operator Lifecycle Manager.
The best practice / workaround here seems to be to create an operator which in turn deploys the necessary DaemonSets and then certify that operator - which in turns allows us to specify this as a dependency for the rest of our operators.
We had similar discussions a while ago / the topic comes up every now and then, whether we want a stackable operator that is in charge of updating our components / internal configmaps etc. Sort of like a k8s internal stackablectl.
I think it is worth writing an ADR and evaluating the various options that we have to
a) solve the concrete matter of getting secret and listener operator OpenShift certifiable
b) look at this from a bit further away and consider if we need a stackable operator
We briefly discussed this in the openshift slack channel: https://stackable-workspace.slack.com/archives/C03DGUK815E/p1662631718184049 and came up with these options as an initial list (there will probably be more, this is not a conclusive list):
- Have Stackable operator that works somewhat analogue to stackablectl but from inside the cluster
- Create an operator specifically for openshift to become compliant, leave everything else as is
- Rework secret and listener operator minimally to simply deploy one pod which then in turn deploys the daemonset
- 3 but have that "one pod" be the commons operator
This is done when:
- The ADR is approved and merged and an option was chosen
- Follow up tickets for the chosen option have been created
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the OpenShift Slack discussion and the four proposed approaches, then inspect existing ADRs in the documentation repository for the expected structure and approval process. Evaluate the options for OpenShift certification and a broader Stackable operator, and consider the work complete when an ADR is approved and merged with one option chosen and follow-up tickets created.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- devops, documentation, infrastructure
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100