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

Init Openshift documentation #1315

Merged
merged 14 commits into from
Jul 25, 2019
Merged

Conversation

barkbay
Copy link
Contributor

@barkbay barkbay commented Jul 22, 2019

This PR adds some documentation for Openshift (mostly for running the quickstart on it)

@barkbay barkbay self-assigned this Jul 22, 2019
@barkbay barkbay added >docs Documentation v0.9.0 labels Jul 22, 2019
barkbay and others added 2 commits July 22, 2019 12:52
Co-Authored-By: Peter Brachwitz <peter.brachwitz@gmail.com>
@barkbay barkbay marked this pull request as ready for review July 22, 2019 12:32
Copy link

@ron1 ron1 left a comment

Choose a reason for hiding this comment

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

Would it make sense to identify which portions of this document are relevant when installing on OpenShift via OLM?

Also, is there a way to avoid the elastic-system namespace and co-locate the global and namespace roles/operator in each namespace with the goal being to rollout operator upgrades in a controlled fashion, one namespace at a time. The global role/operator seems to make that difficult.

barkbay and others added 2 commits July 22, 2019 18:23
Co-Authored-By: Anya Sabo <1638148+anyasabo@users.noreply.github.com>
oc new-project elastic # creates the elastic project
----
+
By default the operator will watch and create resources in the `default` namespace. You need to patch the operator to manage resources in an other namespace.
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth providing an example of listening cluster wide here as well, since I imagine that is a common use case

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would be tempted to say that it is not specific to Openshift, so it should be documented elsewhere. That said it's an interesting point, I'm not sure we have a document explaining how to do that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah that's a good point. We should definitely add that to a larger configuration doc and perhaps link to it from here

@anyasabo
Copy link
Contributor

Would it be worthwhile to document the APM limitations in this doc as well?

@barkbay
Copy link
Contributor Author

barkbay commented Jul 23, 2019

Would it be worthwhile to document the APM limitations in this doc as well?

It will not run, the Docker image is not compatible with restricted environments like Openshift: elastic/beats#12905

I will add a note in the APM documentation (I'm working on it)

@barkbay barkbay requested a review from alaudazzi July 23, 2019 13:05
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

Some minor rewording.

@anyasabo
Copy link
Contributor

This was nice work! Just some minor nits and suggest adding a section on running a cluster wide operator

barkbay and others added 2 commits July 24, 2019 13:03
Co-Authored-By: Anya Sabo <1638148+anyasabo@users.noreply.github.com>
@barkbay
Copy link
Contributor Author

barkbay commented Jul 24, 2019

Thank you all for your great feedback ! ❤️
Let me know if I missed something.

@barkbay barkbay requested review from alaudazzi and anyasabo July 24, 2019 11:45
@anyasabo
Copy link
Contributor

Just noticed two minor nits that could take or leave, either way 🥇

@barkbay
Copy link
Contributor Author

barkbay commented Jul 25, 2019

Would it make sense to identify which portions of this document are relevant when installing on OpenShift via OLM?

Good point, I will address it in an other PR.

@barkbay barkbay merged commit 613fb82 into elastic:master Jul 25, 2019
barkbay added a commit to barkbay/cloud-on-k8s that referenced this pull request Jul 25, 2019
barkbay added a commit that referenced this pull request Jul 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs Documentation v0.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants