Add support for `up ctp provider install` and `up ctp configuration install` #261

hasheddan · 2022-09-27T13:27:48Z

Description of your changes

Adds configuration and provider install commands to the ctp group. The
same struct is used for both commands, but variable interpolation is
used to parameterize based on the subtree from which the command is
invoked.

Signed-off-by: hasheddan georgedanielmangum@gmail.com

Fixes #159

I have:

Read and followed Upbound's contribution process.
Run make reviewable to ensure this PR is ready for review.
Added backport release-x.y labels to auto-backport this PR, as appropriate.

How has this code been tested

Verified successful install of providers and configurations, as well as updates to functionality in up upbound commands.

🤖 (up) kind create cluster
Creating cluster "kind" ...
 ✓ Ensuring node image (kindest/node:v1.21.1) 🖼
 ✓ Preparing nodes 📦  
 ✓ Writing configuration 📜 
 ✓ Starting control-plane 🕹️ 
 ✓ Installing CNI 🔌 
 ✓ Installing StorageClass 💾 
Set kubectl context to "kind-kind"
You can now use your cluster with:

kubectl cluster-info --context kind-kind

Have a question, bug, or feature request? Let us know! https://kind.sigs.k8s.io/#community 🙂
🤖 (up) up uxp install
UXP 1.9.1-up.1 installed
🤖 (up) up ctp provider -h
Usage: up controlplane (ctp) provider <command>

Manage Providers.

Flags:
  -h, --help                         Show context-sensitive help.
  -v, --version                      Print version and exit.
  -q, --quiet                        Suppress all output.
      --pretty                       Pretty print output.

      --domain=https://upbound.io    Root Upbound domain ($UP_DOMAIN).
      --profile=STRING               Profile used to execute command ($UP_PROFILE).
  -a, --account=STRING               Account used to execute command ($UP_ACCOUNT).
      --insecure-skip-tls-verify     [INSECURE] Skip verifying TLS certificates ($UP_INSECURE_SKIP_TLS_VERIFY).

Commands:
  controlplane (ctp) provider install    Install a Provider.
🤖 (up) up ctp configuraiton -h
up: error: unexpected argument configuraiton, did you mean "configuration"?
🤖 (up) up ctp configuration -h
Usage: up controlplane (ctp) configuration <command>

Manage Configurations.

Flags:
  -h, --help                         Show context-sensitive help.
  -v, --version                      Print version and exit.
  -q, --quiet                        Suppress all output.
      --pretty                       Pretty print output.

      --domain=https://upbound.io    Root Upbound domain ($UP_DOMAIN).
      --profile=STRING               Profile used to execute command ($UP_PROFILE).
  -a, --account=STRING               Account used to execute command ($UP_ACCOUNT).
      --insecure-skip-tls-verify     [INSECURE] Skip verifying TLS certificates ($UP_INSECURE_SKIP_TLS_VERIFY).

Commands:
  controlplane (ctp) configuration install    Install a Configuration.
🤖 (up) up ctp provider install -h
Usage: up controlplane (ctp) provider install <package>

Install a Provider.

Arguments:
  <package>    Reference to the Provider.

Flags:
  -h, --help                                             Show context-sensitive help.
  -v, --version                                          Print version and exit.
  -q, --quiet                                            Suppress all output.
      --pretty                                           Pretty print output.

      --domain=https://upbound.io                        Root Upbound domain ($UP_DOMAIN).
      --profile=STRING                                   Profile used to execute command ($UP_PROFILE).
  -a, --account=STRING                                   Account used to execute command ($UP_ACCOUNT).
      --insecure-skip-tls-verify                         [INSECURE] Skip verifying TLS certificates ($UP_INSECURE_SKIP_TLS_VERIFY).

      --kubeconfig=STRING                                Override default kubeconfig path.
      --name=STRING                                      Name of Provider.
      --package-pull-secrets=PACKAGE-PULL-SECRETS,...    List of secrets used to pull Provider.
  -w, --wait=DURATION                                    Wait duration for successful Provider installation.
🤖 (up) up ctp configuration install -h
Usage: up controlplane (ctp) configuration install <package>

Install a Configuration.

Arguments:
  <package>    Reference to the Configuration.

Flags:
  -h, --help                                             Show context-sensitive help.
  -v, --version                                          Print version and exit.
  -q, --quiet                                            Suppress all output.
      --pretty                                           Pretty print output.

      --domain=https://upbound.io                        Root Upbound domain ($UP_DOMAIN).
      --profile=STRING                                   Profile used to execute command ($UP_PROFILE).
  -a, --account=STRING                                   Account used to execute command ($UP_ACCOUNT).
      --insecure-skip-tls-verify                         [INSECURE] Skip verifying TLS certificates ($UP_INSECURE_SKIP_TLS_VERIFY).

      --kubeconfig=STRING                                Override default kubeconfig path.
      --name=STRING                                      Name of Configuration.
      --package-pull-secrets=PACKAGE-PULL-SECRETS,...    List of secrets used to pull Configuration.
  -w, --wait=DURATION                                    Wait duration for successful Configuration installation.
🤖 (up) up ctp provider install upbound/provider-aws:v0.15.0 --package-pull-secrets=pull-sec -w 30s --pretty
  √   upbound-provider-aws installed and healthy                                                                                                                                                               
🤖 (up) k get pkg
NAME                                              INSTALLED   HEALTHY   PACKAGE                                        AGE
provider.pkg.crossplane.io/upbound-provider-aws   True        True      xpkg.upbound.io/upbound/provider-aws:v0.15.0   33s
🤖 (up) up ctp configuration install upbound/platform-ref-aws:v0.2.3
upbound-platform-ref-aws installed
🤖 (up) k get pkg
NAME                                                 INSTALLED   HEALTHY   PACKAGE                                                                 AGE
provider.pkg.crossplane.io/crossplane-provider-aws   True        Unknown   registry.upbound.io/crossplane/provider-aws:v0.32.0-rc.0.47.gd90a07b6   7s
provider.pkg.crossplane.io/upbound-provider-aws      True        True      xpkg.upbound.io/upbound/provider-aws:v0.15.0                            101s

NAME                                                       INSTALLED   HEALTHY   PACKAGE                                           AGE
configuration.pkg.crossplane.io/upbound-platform-ref-aws   True        Unknown   xpkg.upbound.io/upbound/platform-ref-aws:v0.2.3   10s

Moves the dynamic watch logic to the kube package such that it can be used across commands. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Creates an upterm package that contains pterm styling used across commands. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Updates upbound subcommands to consume functionality from the shared dynamic watcher and pterm styles package. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Adds a package resource to the resources package to make accessing common conditions simpler. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Adds a pkg command group, which currently only includes an install command, but can be used for both providers and configurations when included by parent command. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Adds configuration and provider install commands to the ctp group. The same struct is used for both commands, but variable interpolation is used to parameterize based on the subtree from which the command is invoked. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Adds support for --package-pull-secrets to allow specifying pull secrets on package installation. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

AlainRoy · 2022-09-27T18:16:11Z

cmd/up/controlplane/pkg/install.go

+	// NOTE(hasheddan): kong automatically cleans paths tagged with existingfile.
+	Kubeconfig         string        `type:"existingfile" help:"Override default kubeconfig path."`
+	Name               string        `help:"Name of ${package_type}."`
+	PackagePullSecrets []string      `help:"List of secrets used to pull ${package_type}."`


Is this a user-facing help string? If I was the user, I'd ask if the list is space-delimited, comma-delimited, or something else.

@AlainRoy kong mostly handles this for us by displaying comma-separated, but open to feedback on the formatting (we can override pretty much everything):

--package-pull-secrets=PACKAGE-PULL-SECRETS,... List of secrets used to pull Provider

If we do want to override this, we should do it across the board, which I'll likely break into a separate chunk of work 👍🏻

Given that it shows an example with a comma, I'm happy. I might be tempted to change "List" to "Comma-separated list", but I really don't feel strongly since the example makes it clear.

AlainRoy · 2022-09-27T18:17:09Z

internal/kube/watch.go

@@ -0,0 +1,76 @@
+// Copyright 2021 Upbound Inc


Ah! These are auto-generated from a template, time to bump this :)

Updates header template to 2022. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

tnthornton

Thanks for doing this @hasheddan! Just some non-blocking comments and a nit. Feel free to act on those if you wish 👍.

tnthornton · 2022-09-28T17:43:53Z

cmd/up/controlplane/controlplane.go

+	Configuration pkg.Cmd `cmd:"" set:"package_type=Configuration" help:"Manage Configurations."`
+	Provider      pkg.Cmd `cmd:"" set:"package_type=Provider" help:"Manage Providers."`


[non-blocking]: Is this the first place we using multi-word variables in the Kong declarations? The snake case stands out to me. It looks like the other place we have a multi-word variable is controlplane which is all lowercase. I'm assuming snakecase is used for legibility (👍 ), curious if there was a active choice to go that path over camelcase.

@tnthornton this actually is just internal machinery for variable interpolation, it is never surfaced to the end user 👍🏻

tnthornton · 2022-09-28T17:49:27Z

internal/resources/package.go

+)
+
+type Package struct {
+	unstructured.Unstructured


Definitely not the first time we've used this pattern (across repos) 😄. Before too long it might be worth considering moving these resource operations to a shared place.

Definitely agree on that 👍🏻 Thought about doing a larger refactor here, but decided to keep it for now until we feel a bit more pain around it

tnthornton · 2022-09-28T17:51:23Z

internal/upterm/styles.go

+	RaisedPrefix = pterm.Prefix{
+		Style: &pterm.Style{pterm.FgLightMagenta},
+		Text:  " 🙌",
+	}


nit - thoughts on keeping the prefixes together? i.e. this was separated from the EyesPrefix and it's not clear why.

Totally makes sense, didn't realize I had separated them 👍🏻

Organizes printer prefixes to live next to each other. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

hasheddan added 7 commits September 27, 2022 09:12

Move dynamic watch logic to kube package

1fe092d

Moves the dynamic watch logic to the kube package such that it can be used across commands. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Create upterm package for shared pterm styling

e46a335

Creates an upterm package that contains pterm styling used across commands. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Update upbound subcommands to consume new packages

d01eada

Updates upbound subcommands to consume functionality from the shared dynamic watcher and pterm styles package. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Add package resource type to ease access of common fields

46bccd2

Adds a package resource to the resources package to make accessing common conditions simpler. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

Add support for supplying package pull secrets to pkg install

72e61f3

Adds support for --package-pull-secrets to allow specifying pull secrets on package installation. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

hasheddan requested a review from tnthornton September 27, 2022 13:27

pull-request-size bot added the size/XL label Sep 27, 2022

hasheddan requested review from AlainRoy, epk and jastang September 27, 2022 17:51

AlainRoy reviewed Sep 27, 2022

View reviewed changes

Update copyright template to 2022

894b58e

Updates header template to 2022. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

tnthornton approved these changes Sep 28, 2022

View reviewed changes

Group printer prefixes together

24f4a46

Organizes printer prefixes to live next to each other. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>

hasheddan merged commit fde467c into upbound:main Sep 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for `up ctp provider install` and `up ctp configuration install` #261

Add support for `up ctp provider install` and `up ctp configuration install` #261

hasheddan commented Sep 27, 2022 •

edited

AlainRoy Sep 27, 2022

hasheddan Sep 27, 2022

AlainRoy Sep 27, 2022

AlainRoy Sep 27, 2022

hasheddan Sep 27, 2022

tnthornton left a comment

tnthornton Sep 28, 2022

hasheddan Sep 28, 2022

tnthornton Sep 28, 2022

hasheddan Sep 28, 2022

tnthornton Sep 28, 2022

hasheddan Sep 28, 2022

		Configuration pkg.Cmd `cmd:"" set:"package_type=Configuration" help:"Manage Configurations."`
		Provider pkg.Cmd `cmd:"" set:"package_type=Provider" help:"Manage Providers."`

Add support for up ctp provider install and up ctp configuration install #261

Add support for up ctp provider install and up ctp configuration install #261

Conversation

hasheddan commented Sep 27, 2022 • edited

Description of your changes

How has this code been tested

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

tnthornton left a 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

Add support for `up ctp provider install` and `up ctp configuration install` #261

Add support for `up ctp provider install` and `up ctp configuration install` #261

hasheddan commented Sep 27, 2022 •

edited