Using team namespaces: Kubeconfig Step Thru #616

mplsgrant · 2024-09-24T03:31:09Z

I've created this as an extension on #598. It includes

some light admin documentation
an update to user permissions
an updated deploy function to create tanks in a specific namespace and "--to-all-users"
an updated down function that asks before nuking a whole wargame (and a "--force" to not bother asking)
e2e test
handling of namespace throughout many other functions: status, logs, etc
connecting nodes across namespaces using dns: tank-0003.wargames-blue-team.svc.cluster.local
fix to continue checking the init container if at first it can't be found
solves namespaces destroy needs to target wargames namespaces #618

bdp-DrahtBot · 2024-09-24T03:31:15Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

No conflicts as of last run.

mplsgrant · 2024-09-27T07:54:29Z

@josibake Made my changes in this Stepthru pull. The prefix logic in #598 wasn't working like I wanted.
I plan to look into this again Fri afternoon.

josibake · 2024-09-27T13:46:45Z

Nice, took a brief look and this looks good! I think the prefix approach is fine, and then we can revisit in a follow up a more comprehensive approach based on labels/annotations, which would remove the need for any sort of naming convention in our namespaces.

josibake · 2024-10-01T08:53:52Z

Did a walk through of the commits, looks good. I think it would be helpful to squash the commits into logical groups, e.g., one commit for adding the ns option to the cli arguments, one commit for all of the namespace prefix logic, etc. I found it a bit confusing to step through each commit where later commits were re-editing lines of code that had already been touched.

Alternatively, people can just review the files, but given the scope of the PR I think logical commits would be helpful.

mplsgrant · 2024-10-01T18:11:49Z

@josibake Updated the commit structure as you suggested.

mplsgrant · 2024-10-02T14:59:09Z

@josibake This PR is looking good I think. Added a flag to deploy so that we can easily deploy the network to multiply namespaces at once.

mplsgrant · 2024-10-02T17:51:10Z

rebased on main

pinheadmz

ok this is a lot, i breezed through each commit and added one comment. going to focus on test and docs next

pinheadmz · 2024-10-03T11:45:55Z

src/warnet/admin.py

+    namespace: {namespace}
+    user: {sa}
+current-context: {sa}-{namespace}
+"""


might be cleaner to implement as a dict and then use yaml.dump()

Fixed here: f50dcf8 "admin: make kubeconfig a dict"

pinheadmz · 2024-10-03T12:32:55Z

src/warnet/bitcoin.py

+    if not namespace:
+        namespace = get_default_namespace()


i wonder if the repetition of this can be smoothed out with a function decorator like @needs_namespace that can be applied to all relevant commands

Fixed here: 2a906e2 "DRY out the namespace check"

And use yaml.dump

`get_namespaces_by_prefix` is now renamed to `get_namespaces_by_type` in anticipation of using labels in the future.

We use this to check if the current user can delete pods.

We want to back out early if the user is not able to bring down the network

The K8sError allows us to easily handle one single error that crops up from functions that life in k8s.py. Right now I just have it implemented in the open/write kubeconfig functions.

We use this following to check for the scenario file: while [ ! -f /shared/archive.pyz ]; do echo "Waiting for /shared/archive.pyz to exist..." sleep 2 done I suspect this may cut off longer-running copy commands. Using mv we make sure all the data is copied over, and then we `mv` the file into place.

mplsgrant · 2024-10-08T00:27:42Z

rebased on main

This was referenced Sep 24, 2024

swap out kubectl #614

Open

Add --debug option to run scenarios for faster development #612

Merged

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch from 1dde333 to 730b203 Compare September 24, 2024 03:37

mplsgrant requested a review from josibake September 24, 2024 14:28

This was referenced Sep 26, 2024

Add cmd for creating user kubeconfigs (cont. from #545) #598

Closed

Make test_framework available for users when creating scenarios #621

Merged

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch 4 times, most recently from c92bb66 to 6f5264b Compare September 30, 2024 17:47

mplsgrant marked this pull request as ready for review October 1, 2024 06:45

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch from 966363b to dc39367 Compare October 1, 2024 07:26

mplsgrant changed the title ~~Kubeconfig Step Thru~~ Using team namespaces: Kubeconfig Step Thru Oct 1, 2024

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch 2 times, most recently from 822f0c8 to 531e436 Compare October 1, 2024 18:10

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch 5 times, most recently from 41c6727 to 0dbeac8 Compare October 2, 2024 14:51

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch from 0dbeac8 to fa08a48 Compare October 2, 2024 17:50

pinheadmz reviewed Oct 3, 2024

View reviewed changes

mplsgrant and others added 26 commits October 7, 2024 19:25

testing: bring service account checking "in house"

e208c0e

service_accounts: remove func from admin section

7135973

admin: make kubeconfig a dict

30af65a

And use yaml.dump

constants: use labels to select pods for log

5188108

rename to get_namespaces_by_type

2bb87ec

`get_namespaces_by_prefix` is now renamed to `get_namespaces_by_type` in anticipation of using labels in the future.

k8s: add can_delete_pods function

2cf8292

We use this to check if the current user can delete pods.

control: update down with can_delete_pods

d6f4ed3

We want to back out early if the user is not able to bring down the network

admin.md: update namespace deploy command

bfc778b

bitcoin: make ruff happy

ae19f28

k8s: add open/write kubeconfig fn; add K8sError

e7dbaf1

The K8sError allows us to easily handle one single error that crops up from functions that life in k8s.py. Right now I just have it implemented in the open/write kubeconfig functions.

constants: remove --create-namespace

5a38e92

testing: specify warnettest in named items

7320758

testing: update test to include cleanup

4876415

constants: does graph_test.py need --create-namespace?

971afb9

k8s: get raw config values from kubectl

506bd58

k8s: get cluster from current context

02cf9e5

auth: update auth func to avoid flattening

a9239a7

admin: get raw cluster for auth file

ed5fb00

bitcoin: update message to take tank-a.namespace

6ecc017

deploy: fix override path

21815f0

admin.md: reword deploy documentation

1024bcf

removing --create-namespace from constants

8024236

removing --create-namespace from constants

82cf687

gitignore: add kubeconfigs dir

d9b3e1d

k8s: add sync to make sure the data is written

424eba8

mplsgrant force-pushed the 2024-09-create-kube-configs-stepthru branch from f35c0c4 to 424eba8 Compare October 8, 2024 00:25

pinheadmz merged commit 26ca399 into bitcoin-dev-project:main Oct 8, 2024
11 checks passed

mplsgrant deleted the 2024-09-create-kube-configs-stepthru branch October 8, 2024 02:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using team namespaces: Kubeconfig Step Thru #616

Using team namespaces: Kubeconfig Step Thru #616

mplsgrant commented Sep 24, 2024 •

edited

Loading

bdp-DrahtBot commented Sep 24, 2024 •

edited

Loading

mplsgrant commented Sep 27, 2024

josibake commented Sep 27, 2024

josibake commented Oct 1, 2024

mplsgrant commented Oct 1, 2024

mplsgrant commented Oct 2, 2024

mplsgrant commented Oct 2, 2024

pinheadmz left a comment

pinheadmz Oct 3, 2024

mplsgrant Oct 3, 2024 •

edited

Loading

pinheadmz Oct 3, 2024

mplsgrant Oct 3, 2024 •

edited

Loading

mplsgrant commented Oct 8, 2024

Using team namespaces: Kubeconfig Step Thru #616

Using team namespaces: Kubeconfig Step Thru #616

Conversation

mplsgrant commented Sep 24, 2024 • edited Loading

bdp-DrahtBot commented Sep 24, 2024 • edited Loading

Conflicts

mplsgrant commented Sep 27, 2024

josibake commented Sep 27, 2024

josibake commented Oct 1, 2024

mplsgrant commented Oct 1, 2024

mplsgrant commented Oct 2, 2024

mplsgrant commented Oct 2, 2024

pinheadmz left a comment

Choose a reason for hiding this comment

pinheadmz Oct 3, 2024

Choose a reason for hiding this comment

mplsgrant Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

pinheadmz Oct 3, 2024

Choose a reason for hiding this comment

mplsgrant Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

mplsgrant commented Oct 8, 2024

mplsgrant commented Sep 24, 2024 •

edited

Loading

bdp-DrahtBot commented Sep 24, 2024 •

edited

Loading

mplsgrant Oct 3, 2024 •

edited

Loading

mplsgrant Oct 3, 2024 •

edited

Loading