Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaks to kuadrantctl install - error handling for missing deps. #54

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

jasonmadigan
Copy link
Member

@jasonmadigan jasonmadigan commented Feb 29, 2024

Added some error handling for missing deps when running kuadrantctl install.

Note: we're installing an earlier version of the operator - I'll submit another PR to update things to install v0.6.1

Testing

# build kuadrantctl
make install

kind create cluster

# cert-manager
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml

# GW API CRDs
kubectl get crd gateways.gateway.networking.k8s.io &> /dev/null || \
  { kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v1.0.0" | kubectl apply -f -; }

# Istio
(curl -L https://istio.io/downloadIstio | sh - && cd istio-* && ./bin/istioctl install --set profile=default -y)

# OLM
curl -L https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.27.0/install.sh | bash -s v0.27.0

bin/kuadrantctl install

@jasonmadigan jasonmadigan force-pushed the install-olm-error branch 2 times, most recently from f1a19c4 to 8639431 Compare February 29, 2024 16:20
var dependencyErrors []error

// Perform each check and collect errors
if err := checkCRDExistence(k8sClient, "gateways.networking.istio.io", "https://istio.io/latest/docs/setup/additional-setup/getting-started/"); err != nil {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@david-martin david-martin Mar 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it stands, the dependency error instructs to 'Please follow the installation guide at..'
If that is and always will be the same as what other docs (like on docs.kuadrant.io) will say, then that seems like a good dev exp as it brings them closer to the solution quicker than having to parse through the prerequisites section of guide that may have multiple prerequisites.

If however it may be different, like specifying a specific version or a specific way of installing, then linking to docs.kuadrant.io is the safest as that is something actively being maintained and tested with each release

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like your point about getting people to the right information, sooner. I think these looks are generic/non-versioned enough to be quite stable.

@jasonmadigan
Copy link
Member Author

Follow-on: #56

@R-Lawton R-Lawton merged commit 0ae03a5 into main Mar 1, 2024
5 checks passed
@eguzki eguzki deleted the install-olm-error branch May 15, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants