[DPE-5976] Add admin user #9

reneradoi · 2024-12-02T16:43:50Z

This PR adds the following functionality to the etcd-operator:

automatically create an internal admin user (root as per etcd standard)
always enable authentication in the etcd cluster on startup
methods add_user(), update_password() and enable_auth() in the EtcdClient class
a configuration option system-users with which users can configure a secret_id. The corresponding secret has to be granted to the etcd application and has to include the password as key root=....
unit and integration test coverage for the above mentioned

…nt handler

…form

…der to avoid KeyErrors

…t_leader` method to ClusterManager

…rom the event handlers

# Conflicts: # src/charm.py # src/events/etcd.py # src/managers/cluster.py # tests/unit/test_charm.py

skourta

Great work @reneradoi. I left some comments

src/common/client.py

src/common/exceptions.py

src/core/models.py

src/events/actions.py

tests/unit/test_actions.py

tests/unit/test_charm.py

tests/integration/test_charm.py

src/common/client.py

skourta

Thank you!

pyproject.toml

actions.yaml

src/literals.py

skourta

Minor comments. Well done @reneradoi

src/common/secrets.py

src/events/etcd.py

config.yaml

…ternal users in the referenced secret

src/events/etcd.py

reneradoi added 30 commits November 11, 2024 08:53

disable allure reports for now (will be added later)

27c9541

implement on_install hook

7e8b0a7

fix linting, add snap lib

262bacd

implement peer relation handler

28c34ef

fix linting

97d2cde

move base events from charm.py to EtcdEvents class

bf1c3a2

temporarily move population peer relation unit data to start-hook

723d2c0

add peer relation to unit test

a1d9d75

add alive-check for snap, add handler for update_status event

0396f3e

fix unit testing

6531227

decouple cluster manager from charm.py, should be instantiated by eve…

a4939b8

…nt handler

implement basic ConfigManager

9c0e820

add basic configuration required for initial startup of etcd cluster

77d2395

use pathlib instead of os to create filepath for config file

ccae158

use Path object to create directory path and write file

84c378f

rename peer-relation to etcd-peers for consistency within data plat…

0142dc4

…form

use pop instead of del for deleting keys from relation data in or…

eb6bf16

…der to avoid KeyErrors

use app.name instead of hardcoded etcd for cluster-member-name

d023cab

use socket.gethostbyname for ip address

d89d7d0

add retry-mechanism to workload-init and installation

e39a322

WIP: add EtcdClient class for executing etcdctl commands, add `ge…

81fe2d9

…t_leader` method to ClusterManager

WIP: refactor - managers should be instantiated from the charm, not f…

38800a9

…rom the event handlers

WIP: add generic method to execute etcdctl commands

233d0de

add unit test coverage for EtcdClient and ClusterManager

834efd9

Merge branch 'main' into add_cluster_manager

ecc1da7

# Conflicts: # src/charm.py # src/events/etcd.py # src/managers/cluster.py # tests/unit/test_charm.py

doc string comment

6e3879b

minor changes on comments, logging and naming

e45b742

return None instead of empty strings to enforce type checking

fc7f80a

Move EtcdClient to a separate file

b8ea77f

create internal admin user on_install

01fe2ab

reneradoi changed the title ~~[DEP-5976] Add admin user~~ [DPE-5976] Add admin user Dec 5, 2024

skourta reviewed Dec 6, 2024

View reviewed changes

address PR review feedback

9886c5f

reneradoi requested a review from skourta December 6, 2024 09:26

skourta reviewed Dec 6, 2024

View reviewed changes

src/common/client.py Outdated Show resolved Hide resolved

fix replacing Optional with str | None

124d5fd

reneradoi requested a review from skourta December 6, 2024 11:43

skourta reviewed Dec 6, 2024

View reviewed changes

src/common/client.py Outdated Show resolved Hide resolved

fix type hint

2c5ebe6

reneradoi requested a review from skourta December 6, 2024 11:55

skourta previously approved these changes Dec 6, 2024

View reviewed changes

delgod requested changes Dec 6, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

actions.yaml Outdated Show resolved Hide resolved

src/literals.py Show resolved Hide resolved

remove implementation for get-password and set-password user actions

ec03f83

reneradoi dismissed skourta’s stale review via ec03f83 December 6, 2024 14:40

reneradoi added 3 commits December 9, 2024 11:19

WIP: configure admin's user password via juju user secret

8ee63e5

add test coverage

ea8b4c9

fix linting

0af4d26

reneradoi requested review from delgod and skourta December 9, 2024 13:51

add test for password to be still valid if config option was removed

fa8cee1

skourta previously approved these changes Dec 10, 2024

View reviewed changes

src/common/secrets.py Show resolved Hide resolved

src/events/etcd.py Show resolved Hide resolved

src/events/etcd.py Show resolved Hide resolved

delgod requested changes Dec 10, 2024

View reviewed changes

config.yaml Outdated Show resolved Hide resolved

rename config option to system-users, allow for storing multiple in…

66bee61

…ternal users in the referenced secret

reneradoi dismissed skourta’s stale review via 66bee61 December 10, 2024 11:00

reneradoi requested review from skourta and delgod December 10, 2024 11:20

delgod approved these changes Dec 10, 2024

View reviewed changes

src/events/etcd.py Show resolved Hide resolved

skourta approved these changes Dec 10, 2024

View reviewed changes

reneradoi merged commit 6ff42c1 into main Dec 10, 2024
11 of 12 checks passed

reneradoi deleted the add_admin_user branch December 10, 2024 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DPE-5976] Add admin user #9

[DPE-5976] Add admin user #9

reneradoi commented Dec 2, 2024 •

edited by delgod

Loading

skourta left a comment

skourta left a comment

skourta left a comment

[DPE-5976] Add admin user #9

[DPE-5976] Add admin user #9

Conversation

reneradoi commented Dec 2, 2024 • edited by delgod Loading

skourta left a comment

Choose a reason for hiding this comment

skourta left a comment

Choose a reason for hiding this comment

skourta left a comment

Choose a reason for hiding this comment

reneradoi commented Dec 2, 2024 •

edited by delgod

Loading