canonical / canonical/operator

Investigate subordinate charms and update the doc

Open
#2,460 1 comment 0 reactions 0 assignees View on GitHub
27.04 docs roadmap
Dominant language
Python
Stars
267
Forks
136
Avg merge
1d 22h
Merged PRs (30d)
28

Description

In https://github.com/canonical/operator/pull/2455 we're adding a summary doc about subordinate charms. While researching this doc, we identified several questions that may need to be answered in a future version of the doc:

1. What data can subordinate units see? Is there a peer relation with other units of the same subordinate charm? [How to manage relations](https://documentation.ubuntu.com/ops/latest/howto/manage-relations/) has some information about relations that involve a subordinate charm. One part of that doc says "subordinate units cannot see each other’s peer data", which I don't understand.

2. Does Juju block relations if the bases are incompatible? Presumably when you deploy the subordinate, Juju wouldn't complain about anything because it doesn't know what you are going to integrate with - at this point no units of the subordinate charm are created.

3. Do we want our own example of a subordinate charm?

Answering these and updating the doc will require some testing and discussion with people who have more knowledge about subordinate charms.

Contributor guide

Open the contributing guide

Research direction

Start with pull request #2455 and the linked “How to manage relations” documentation. Investigate the three subordinate-charm questions through testing and discussion with Juju or charm experts, then update the summary documentation with the answers and any agreed example.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.