Add kind-dev command to start a kind dev cluster #338

Julian-Chu · 2023-04-13T15:26:49Z

Description of changes:
Add make kind-dev SERVICE=$SERVICE to setup a cluster for development or debug quickly.

the command will execute the following actions:

create kind cluster
install CRD and RBAC into cluster without controller

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

RedbackThomson · 2023-04-13T17:11:05Z

scripts/run-dev.sh

I don't think run-dev is a very descriptive name for this file. Could you please rename it to something like setup-kind-cluster or create-dev-cluster?

ya , renamed to create-dev-cluster

RedbackThomson · 2023-04-13T17:13:40Z

scripts/run-dev.sh

+ensure_cluster() {
+      info_msg "Creating KIND cluster ..."
+      setup_kind_cluster "$CLUSTER_NAME" "$CONTROLLER_NAMESPACE"
+
+      info_msg "Installing CRDs , common and RBAC manifest..."
+      install_crd_and_rbac "$CONTROLLER_NAMESPACE"
+}


We already have an ensure_cluster method in another file that achieves a similar premise - https://github.com/aws-controllers-k8s/test-infra/blob/main/scripts/run-e2e-tests.sh#L31-L44

This method also uses the config YAML to determine the name, in case the user wants to use a statically named cluster. Rather than redefining this method here, maybe you could modify that one to have a similar effect and then import and use it in this script.

refactor here refactor ensure_cluster

RedbackThomson · 2023-04-13T17:14:52Z

scripts/run-dev.sh

+    ensure_aws_credentials
+    ensure_cluster
+    local kubeconfig_path="$ROOT_DIR/build/clusters/$CLUSTER_NAME/kubeconfig"
+    info_msg "Before running the controller, you need kubeconfig and aws credentials."


nit: Probably don't need this line of explanation. I think we can assume anyone using this method already knows this

RedbackThomson · 2023-04-13T17:16:36Z

scripts/run-dev.sh

+    info_msg "if you run the controller from your code editor/IDE, you can set the following environment variables:"
+    echo "KUBECONFIG=$kubeconfig_path"


This is already called out from inside the setup_kind_cluster method. See https://github.com/aws-controllers-k8s/test-infra/blob/main/scripts/kind.sh#L27

I think the source command set the kubeconfig in current terminal only, if starting the controller from goland or vscode, we have to set KUBECONFIG into them. but you're right, better to mention in document rather than here.

RedbackThomson · 2023-04-13T17:17:09Z

scripts/run-dev.sh

+    info_msg "After executing the above source command to set the kubeconfig to environment, "
+    info_msg "run the following command to start the controller from the controller repo:"
+    echo ""
+    echo "go run ./cmd/controller/main.go --aws-region eu-central-1 --log-level debug --enable-development-logging"


nit: Instead of hardcoding eu-central-1, get the region from the config YAML (like this)

fixed rename to create-dev-cluster.sh

a-hilaly

Nice, good stuff!
nit: can you please update the title and description of PR to reflect your latest changes? They will be part of your git commit

ack-prow · 2023-04-17T12:26:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: A-Hilaly, Julian-Chu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [A-Hilaly]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Julian-Chu · 2023-04-18T16:39:07Z

@a-hilaly thanks for review, just see your comments. the title and description have been updated!

RedbackThomson · 2023-04-19T18:37:03Z

scripts/run-e2e-tests.sh

+        _ensure_existing_context
+    else
+        local cluster_name=$(get_cluster_name)
+        local controller_install=${2:-true}


Could you please move all of the positional arguments into local variables at the top of this method, so that it's clear what the inputs are. Then you can copy them into their respective variables further down in the method as needed.

moved 4c321c2

RedbackThomson · 2023-04-19T18:38:11Z

scripts/run-e2e-tests.sh

-    else
-        info_msg "Testing connection to existing cluster ..."
-        _ensure_existing_context
+        info_msg "Installing CRDs , common and RBAC manifest..."


Suggested change

info_msg "Installing CRDs , common and RBAC manifest..."

info_msg "Installing CRD and RBAC manifests..."

fixed 4ed9f07

ack-bot · 2023-10-19T23:26:04Z

Issues go stale after 180d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 60d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle stale

ack-bot · 2023-12-19T00:17:31Z

Stale issues rot after 60d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 60d of inactivity.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle rotten

a-hilaly · 2023-12-31T22:21:15Z

@Julian-Chu Are we ready to ship this?

a-hilaly · 2023-12-31T22:21:54Z

Just want to double check that this is not gonna break the existing testing rule

ack-bot · 2024-06-29T02:01:38Z

Issues go stale after 180d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 60d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle stale

Julian-Chu added 4 commits April 12, 2023 23:55

refactor controller-setup.sh

c936ecd

add kind-dev cmd

9829372

add info to run controller

c55529e

update comment in run-dev.sh

7140ad3

ack-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 13, 2023

ack-prow bot requested review from jaypipes and jljaco April 13, 2023 15:26

Julian-Chu marked this pull request as ready for review April 13, 2023 16:42

ack-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 13, 2023

ack-prow bot requested review from a-hilaly and vijtrip2 April 13, 2023 16:42

RedbackThomson suggested changes Apr 13, 2023

View reviewed changes

Julian-Chu added 3 commits April 14, 2023 22:19

rename to create-dev-cluster.sh

177a044

refactor ensure_cluster

7779b28

clean up

6e7926d

Julian-Chu requested a review from RedbackThomson April 15, 2023 20:29

a-hilaly approved these changes Apr 17, 2023

View reviewed changes

ack-prow bot added the approved label Apr 17, 2023

Julian-Chu changed the title ~~Feat/add kind dev~~ Add kind-dev command to start a kind dev cluster Apr 18, 2023

RedbackThomson reviewed Apr 19, 2023

View reviewed changes

Julian-Chu added 2 commits April 22, 2023 22:41

move args into top of function

4c321c2

fix message

4ed9f07

Julian-Chu requested a review from RedbackThomson April 22, 2023 20:50

ack-prow bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 19, 2023

ack-prow bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 19, 2023

a-hilaly removed request for jaypipes, RedbackThomson, vijtrip2 and jljaco December 31, 2023 22:20

a-hilaly removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Dec 31, 2023

ack-prow bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add kind-dev command to start a kind dev cluster #338

Add kind-dev command to start a kind dev cluster #338

Julian-Chu commented Apr 13, 2023 •

edited

Loading

RedbackThomson Apr 13, 2023

Julian-Chu Apr 15, 2023

RedbackThomson Apr 13, 2023

Julian-Chu Apr 15, 2023

RedbackThomson Apr 13, 2023

Julian-Chu Apr 15, 2023

RedbackThomson Apr 13, 2023

Julian-Chu Apr 15, 2023

RedbackThomson Apr 13, 2023

Julian-Chu Apr 15, 2023

a-hilaly left a comment

ack-prow bot commented Apr 17, 2023

Julian-Chu commented Apr 18, 2023

RedbackThomson Apr 19, 2023

Julian-Chu Apr 22, 2023

RedbackThomson Apr 19, 2023

Julian-Chu Apr 22, 2023

ack-bot commented Oct 19, 2023

ack-bot commented Dec 19, 2023

a-hilaly commented Dec 31, 2023

a-hilaly commented Dec 31, 2023

ack-bot commented Jun 29, 2024

		info_msg "if you run the controller from your code editor/IDE, you can set the following environment variables:"
		echo "KUBECONFIG=$kubeconfig_path"

	info_msg "Installing CRDs , common and RBAC manifest..."
	info_msg "Installing CRD and RBAC manifests..."

Add kind-dev command to start a kind dev cluster #338

Are you sure you want to change the base?

Add kind-dev command to start a kind dev cluster #338

Conversation

Julian-Chu commented Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

a-hilaly left a comment

Choose a reason for hiding this comment

ack-prow bot commented Apr 17, 2023

Julian-Chu commented Apr 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ack-bot commented Oct 19, 2023

ack-bot commented Dec 19, 2023

a-hilaly commented Dec 31, 2023

a-hilaly commented Dec 31, 2023

ack-bot commented Jun 29, 2024

Julian-Chu commented Apr 13, 2023 •

edited

Loading