-
Notifications
You must be signed in to change notification settings - Fork 102
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
Improve install experience #311
Conversation
7e5db74
to
2ed3bd7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm
metadata: | ||
labels: | ||
controller-tools.k8s.io: "1.0" | ||
name: kudo-system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so moving KUDO from system
to kudo-system
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
- `make run` to run the Operator with local go environment or `make deploy | kubectl apply -f -` to install to your kubernetes cluster | ||
- `kubectl create -f docs/deployment/00-prereqs.yaml` | ||
- `kubectl create -f docs/deployment/10-crds.yaml` | ||
- `kubectl create -f docs/deployment/20-deployment.yaml` | ||
|
||
### Notes on Minikube | ||
If you plan on developing and testing KUDO locally via Minikube, you'll need to launch your cluster with a reasonable amount of memory allocated. By default, this is only 2GB - we recommend at least 8GB, especially if you're working with applications such as [Kafka](/docs/examples/apache-kafka/). You can start Minikube with some suitable resource adjustments as follows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably also need to update /docs/examples/apache-kafka
at some point
What type of PR is this?
What this PR does / why we need it:
Updates the documentation with instructions on how to easily create all the necessary RBAC prereqs, CRDs and stateful set.