Remove jargon from and simplify README #950
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove a lot of the "operator" and K8s jargon from the top of our README. I feel fairly strongly this isn't the place to sell how great Juju, K8s operators, and model-driven development is -- we should do that on our landing page and/or docs, not in the ops README. Also simplify and update some of the terminology (hopefully consistent with our updated terminology doc, though I've used the "charmed" prefix as there's more than one "Operator Framework"). The first part of the doc is copied to ops/__init__.py for consistency. That appears at the top of our API reference at https://ops.readthedocs.io/ Move the note about depencies to HACKING.md where I think it belongs.
jnsgruk
reviewed
Jun 12, 2023
|
@jnsgruk Thanks for the review -- updates made, ready for re-review. |
Also replace "operator" with "admin" in a few places where it means the human operator, as "operator" is ambiguous. Also have separate TOC entries for each module in docs
jameinel
changed the title
jnsgruk
approved these changes
Jun 14, 2023
|
Merged. Note posted on Charmhub Mattermost > Charm Development, and also at https://discourse.charmhub.io/t/terminology-tweak-operator-framework-ops/10908 |
benhoyt
added a commit
to benhoyt/pebble
that referenced
this pull request
Jun 19, 2023
This goes for services, exec, and health checks of type "exec". This also fixes a long-standing bug in the user/group parameters for "exec" health checks not working at all. This was due to not setting cmd.SysProcAttr, so the "cmd.SysProcAttr.Credential =" line would panic with a nil pointer error. Also a drive-by fix to the README to update to the new terminology. See also canonical/operator#950 Fixes canonical#166
niemeyer
pushed a commit
to canonical/pebble
that referenced
this pull request
Jun 19, 2023
When user and group (or user ID and group ID) options are given when running services and they're equal to the current user and group, avoid setting os/exec's syscall.Credential Uid and Gid, because they require root. In the case when they're explicitly asking to run the command as the current user, we can just run it directly, without requiring root. This goes for services, exec (one-shot commands), and health checks of type "exec". This PR also fixes a long-standing bug in the user/group options for "exec" health checks not working at all. This was due to not setting cmd.SysProcAttr, so the cmd.SysProcAttr.Credential = ... line would panic with a nil pointer error. Also a drive-by fix to the README to update to the new terminology. See also canonical/operator#950. Fixes #166.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
View rendered version updated README.md here.
Remove a lot of the "operator" and K8s jargon from the top of our README. I feel fairly strongly this isn't the place to sell how great Juju, K8s operators, and model-driven development are -- we should do that on our landing page and/or docs, not in the ops README. Charmers shouldn't normally be landing here, and if they do, I think we should give them succinct, developer-oriented documentation.
Also simplify and update some of the terminology to be consistent with our updated Juju Terminology doc.
The first part of the README is copied to
ops/__init__.pyfor consistency. That will appear at the top of our API reference at https://ops.readthedocs.io/Move the note about dependencies to HACKING.md where I think it belongs.