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

Added note about the apiVersion used up to 1.10.0 #283

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,16 @@ To install the operator, run:
[source,bash]
----
kubectl create namespace observability # <1>
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/crds/jaegertracing_v1_jaeger_crd.yaml
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/crds/jaegertracing_v1_jaeger_crd.yaml # <2>
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/service_account.yaml
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/role.yaml
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/role_binding.yaml
kubectl create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/operator.yaml
----
<1> This creates the namespace used by default in the deployment files.
<2> This installs the "Custom Resource Definition" for the `apiVersion: jaegertracing.io/v1`

IMPORTANT: when using a Jaeger Operator up to v1.10.0, install the CRD file `io_v1alpha1_jaeger_crd.yaml` in addition to `jaegertracing_v1_jaeger_crd.yaml`. This is because up to that version, the `apiVersion` in use was `io.jaegertracing/v1alpha1`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this notice be included below aswell?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added. Our ultimate goal is to remove the OpenShift-specific instructions, but until that, we should indeed duplicate the instructions.


If you want to install the Jaeger operator in a different namespace, you will need to edit the deployment
files to change `observability` to the required value.
Expand All @@ -67,13 +70,16 @@ The instructions from the previous section also work on OpenShift. Make sure to
oc login -u system:admin

oc new-project observability # <1>
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/crds/jaegertracing_v1_jaeger_crd.yaml
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/crds/jaegertracing_v1_jaeger_crd.yaml # <2>
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/service_account.yaml
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/role.yaml
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/role_binding.yaml
oc create -f https://github.com/raw/jaegertracing/jaeger-operator/master/deploy/operator.yaml
----
<1> This creates the namespace used by default in the deployment files.
<2> This installs the "Custom Resource Definition" for the `apiVersion: jaegertracing.io/v1`

IMPORTANT: when using a Jaeger Operator up to v1.10.0, install the CRD file `io_v1alpha1_jaeger_crd.yaml` in addition to `jaegertracing_v1_jaeger_crd.yaml`. This is because up to that version, the `apiVersion` in use was `io.jaegertracing/v1alpha1`.

If you want to install the Jaeger operator in a different namespace, you will need to edit the deployment
files to change `observability` to the required value.
Expand Down