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

Change operator.yaml to use master, to keep the readme uptodate with … #296

Merged
merged 1 commit into from
Mar 11, 2019
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
Change operator.yaml to use master, to keep the readme uptodate with …
…latest version

Signed-off-by: Gary Brown <[email protected]>
  • Loading branch information
objectiser committed Mar 11, 2019
commit a57284e50df06074e1c81b508c8022ae8ca8af08
16 changes: 16 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -11,6 +11,22 @@ IMPORTANT: The Jaeger Operator version is related to the version of the Jaeger c

== Installing the operator

NOTE: The following instructions will deploy a version of the operator that is using the latest `master` version. If
you want to install a particular stable version of the operator, you will need to edit the `operator.yaml` and specify
the version as the tag in the container image - and then use the relevant `apiVersion` for the Jaeger operator.

|===
|Up to version |apiVersion |CRD yaml

|master
|jaegertracing.io/v1
|https://github.com/jaegertracing/jaeger-operator/blob/master/deploy/crds/jaegertracing_v1_jaeger_crd.yaml[jaegertracing_v1_jaeger_crd.yaml]

|1.10.0
|io.jaegertracing/v1alpha1
|https://github.com/jaegertracing/jaeger-operator/blob/master/deploy/crds/io_v1alpha1_jaeger_crd.yaml[io_v1alpha1_jaeger_crd.yaml]
|===

=== Kubernetes

NOTE: Make sure your `kubectl` command is properly configured to talk to a valid Kubernetes cluster. If you don't have one yet, check link:https://kubernetes.io/docs/tasks/tools/install-minikube/[`minikube`] out.
2 changes: 1 addition & 1 deletion deploy/operator.yaml
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ spec:
serviceAccountName: jaeger-operator
containers:
- name: jaeger-operator
image: jaegertracing/jaeger-operator:1.10.0
image: jaegertracing/jaeger-operator:master
Copy link
Member

Choose a reason for hiding this comment

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

Is this a temporary fix?

If so add a note to release V1 issue that it has to be changed when releasing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if should be temporary - if we fix on a particular version, then the readme needs to reflect that version until the next stable version is released, rather than the current approach where we update the readme as changes are applied.

Something we should discuss when @jpkrohling is available.

Copy link
Member

Choose a reason for hiding this comment

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

I would expect (and I think most users too) that when you download https://github.com/jaegertracing/jaeger-operator/blob/v1.10.0/deploy/operator.yaml - (mind the tag version in the link) that it would deploy operator with the given version.

Copy link
Contributor

Choose a reason for hiding this comment

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

This change gets overridden every time we do a release:

sed "s~image: jaegertracing/jaeger-operator.*~image: ${BUILD_IMAGE}~gi" -i deploy/operator.yaml

This file is also used as the base for other operator-related files, like the test manifests and OLM CSV (IIRC).

To address the original problem this PR is fixing, I think we could mention in the documentation the version a change will take effect ("from version 1.11.0, the apiVersion should be ...")

ports:
- containerPort: 8383
name: metrics