Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Update Getting Started guide and script #43

Merged
merged 9 commits into from
Oct 27, 2021
Merged

Conversation

mikemorris
Copy link
Contributor

Tweaks a few lines to get the quick start running smoothly.

Would it additionally make sense to break out all the inline YAML into separate files?

dev/getting-started.md Outdated Show resolved Hide resolved
scripts/develop Outdated Show resolved Hide resolved
@andrewstucki
Copy link
Contributor

@mikemorris for the yaml breakout question (which I just saw, sorry) -- I'm fine if we want to move them into their own files rather than being inline (that way we'd also avoid the need to create a tmp folder) -- some things with regard to that:

  1. I'd try and keep them in something like a subfolder of the scripts directory just to avoid scattering dev files in multiple locations and to avoid confusion around what manifests are dev v. production in the long-run (once our kustomize stuff goes in)
  2. You'll probably want to do something like separate out the yaml by type, or at least suffix the files or something so it's readily apparent what folks are looking at. We actually have 4 separate types of inline yaml in the script: Kind configuration, kubernetes manifests, kustomization overlays, and helm values files. Maybe also take the policy created for consul-api-gateway and move it into its own file too?
  3. With regard to the kustomize file that handles the ingress installation to expose the Consul UI locally, it'll need to be named kustomization.yaml and the directory it's in passed to either kubectl kustomize ... | kubectl apply -f - or with kubectl apply -k ....

dev/getting-started.md Outdated Show resolved Hide resolved
Copy link
Contributor

@andrewstucki andrewstucki left a comment

Choose a reason for hiding this comment

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

Just one quick thing about verifying the ordering for the kubectl delete process. If it doesn't work, I'd say just revert to the manually ordered deletion in the markdown directions. If it does, I think this is pretty much good to go.

dev/getting-started.md Show resolved Hide resolved
@mikemorris mikemorris merged commit 8584fa0 into main Oct 27, 2021
@mikemorris mikemorris deleted the dev/getting-started branch October 27, 2021 20:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants