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

Add tooling to spin up local environments #9

Merged
merged 17 commits into from
Dec 14, 2021
Merged

Add tooling to spin up local environments #9

merged 17 commits into from
Dec 14, 2021

Conversation

simu
Copy link
Member

@simu simu commented Dec 9, 2021

Summary

Add shell script and make targets to spin up a kind-based local environment. The setup script prompts the user to setup a dev realm and admin user in an existing Keycloak instance. The PR doesn't provide tooling to spin up a local Keycloak instance at the moment.

Checklist

  • PR contains a single logical change (to build a better changelog).
  • Update the documentation.
  • Categorize the PR by setting a good title and adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog.

@simu simu added the enhancement New feature or request label Dec 9, 2021
@ccremer
Copy link
Contributor

ccremer commented Dec 9, 2021

Just another source of inspiration: In K8up we also did a KIND setup, but based on make: https://github.com/k8up-io/k8up/tree/master/e2e

@tobru
Copy link
Member

tobru commented Dec 9, 2021

Vcluster uses k3s, here we're using kind: We should at least document that so that there is awareness that it isn't the same Kubernetes distro.

@simu
Copy link
Member Author

simu commented Dec 10, 2021

Vcluster uses k3s, here we're using kind: We should at least document that so that there is awareness that it isn't the same Kubernetes distro.

I don't really care what we use, but APUB-155 (internal) explicitly asks for kind

@simu simu marked this pull request as ready for review December 13, 2021 16:07
@simu simu requested review from ccremer, bastjan and glrf December 13, 2021 16:07
Copy link
Contributor

@glrf glrf left a comment

Choose a reason for hiding this comment

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

Works pretty good, I was able to setup a test environment fairly quickly.

I only really care about the README change to reference the make command. The others are just nitpicks.

Makefile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
local-env/README.md Outdated Show resolved Hide resolved
local-env/setup-kind.sh Outdated Show resolved Hide resolved
local-env/setup-kind.sh Outdated Show resolved Hide resolved
local-env/setup-kind.sh Outdated Show resolved Hide resolved
Copy link
Contributor

@bastjan bastjan left a comment

Choose a reason for hiding this comment

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

It worked for me with make -C local-env setup after some trial and error.

The admin user has to have an email. Just toggling to email verified is not enough.

local-env/setup-kind.sh Outdated Show resolved Hide resolved
local-env/setup-kind.sh Show resolved Hide resolved
@simu simu requested review from glrf and bastjan December 14, 2021 10:17
Copy link
Contributor

@bastjan bastjan left a comment

Choose a reason for hiding this comment

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

LGTM. The instructions and guided steps now make it quite easy to setup the dev environment! 🧙‍♂️

Copy link
Contributor

@ccremer ccremer left a comment

Choose a reason for hiding this comment

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

It worked well for me. Just small suggestions

local-env/setup-kind.sh Outdated Show resolved Hide resolved
local-env/setup-kind.sh Outdated Show resolved Hide resolved
Co-authored-by: Chris <github.account@chrigel.net>
@simu simu merged commit 735c69b into master Dec 14, 2021
@simu simu deleted the feat/local-env branch December 14, 2021 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants