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

Improve install experience #311

Merged
merged 3 commits into from
Jun 7, 2019
Merged

Improve install experience #311

merged 3 commits into from
Jun 7, 2019

Conversation

gkleiman
Copy link
Contributor

@gkleiman gkleiman commented Jun 7, 2019

What type of PR is this?

/kind documentation

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.

@gkleiman gkleiman requested a review from gerred June 7, 2019 16:36
@gkleiman gkleiman force-pushed the improved-install-experience branch from 7e5db74 to 2ed3bd7 Compare June 7, 2019 16:46
@gkleiman gkleiman requested a review from fabianbaier June 7, 2019 17:22
@gkleiman gkleiman marked this pull request as ready for review June 7, 2019 17:22
Copy link
Member

@fabianbaier fabianbaier left a 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
Copy link
Member

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 ?

Copy link
Member

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:
Copy link
Member

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

@gerred gerred merged commit 7560376 into master Jun 7, 2019
@gerred gerred deleted the improved-install-experience branch June 7, 2019 18:06
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