Some docs updates for the 0.2.0 release #12233

knrc · 2018-09-28T14:44:57Z

No description provided.

kalexand-rh · 2018-09-28T15:04:34Z

servicemesh-install/topics/install-overview.adoc

kalexand-rh

Couple of style picks. Unless you're referring to a specific OpenShift element, you can't just say "OpenShift." You need to use the {product-title} variable to apply the correct OpenShift product name for the collection.

kalexand-rh · 2018-10-01T13:47:12Z

servicemesh-install/topics/install-overview.adoc

s/OpenShift/{product-title} (multiple places, multiple files)

This was not actually a line I had intended to change, looks as if it was just a newline appended to the content. I can make the change however.

This should now be done

kalexand-rh · 2018-10-01T13:48:29Z

servicemesh-install/topics/install-prerequisites.adoc

+|`prefix`
+|Any valid image repo.
+|Which prefix to apply to the Kiali image name used in docker pull.
+|If deployment_type=origin the default is `kiali/`.


s/deployment_type=origin/`deployment_type=origin` (two places)

This should now be done

kalexand-rh · 2018-10-01T13:48:50Z

servicemesh-install/topics/install-prerequisites.adoc

+|Which prefix to apply to the Kiali image name used in docker pull.
+|If deployment_type=origin the default is `kiali/`.
+
+If deployment_type=openshift the default is `openshift-istio-tech-preview/`.


s/deployment_type=openshift/`deployment_type=openshift`, (two places)

This should now be done

kalexand-rh · 2018-10-01T13:50:55Z

servicemesh-install/topics/install-prerequisites.adoc

+If deployment_type=openshift then `0.7.2`.
+
+|`username`
+|The username used to access the Kiali console. Note that this is not related to any account on OpenShift


s/username/user name

This should now be done

kalexand-rh · 2018-10-01T13:51:15Z

servicemesh-install/topics/install.adoc

@@ -10,12 +10,18 @@ The {ProductShortName} installation process introduces a Kubernetes operator to
 == Installing the operator
 The following steps will install the {ProductShortName} operator into an existing {product-title} 3.10 installation; they can be executed from any host with access to the cluster.  Please ensure you are logged in as a cluster admin before executing the following commands.

-You can find the https://github.com/Maistra/openshift-ansible/tree/maistra-0.1.0-ocp-3.1.0-istio-1.0.0/istio[operator templates on GitHub].
+You can find the https://github.com/Maistra/openshift-ansible/tree/maistra-0.2.0-ocp-3.1.0-istio-1.0.2/istio[operator templates on GitHub].


@vikram-redhat, are you ok with this GitHub reference?

Hi Kevin - @knrc - is this the upstream for ServiceMesh?

@vikram-redhat Yes it is.

@knrc - is there a RH supported link instead? If not, is it confirmed within these docs that Service Mesh is not supported by RH and that this is dev preview only? If yes, we can approve this link.

@vikram-redhat There is no product/supported link as of yet and this release is described as a tech preview within the docs and the images.

Thanks Kevin (@knrc)!

@kalexand-rh - yes we can accept this link.

Thanks Vikram! When Kevin clears the merge errors, I'll merge this PR. :)

kalexand-rh · 2018-10-01T13:52:47Z

servicemesh-install/topics/install.adoc


 ```
 $ oc new-project istio-operator
 $ oc new-app -f istio_product_operator_template.yaml --param=OPENSHIFT_ISTIO_MASTER_PUBLIC_URL=<master public url>
 ```
+[NOTE]
+.OpenShift Master Public URL
+=====================


Four "=" signs

Remove the note label.

Rewrite to not use "should."

s/your OpenShift Console, this/{product-title}. This

This should now be done

brian-avery · 2018-10-03T14:30:07Z

servicemesh-install/topics/install-prerequisites.adoc

@@ -236,22 +267,6 @@ $ oc ex config patch master-config.yaml.prepatch -p "$(cat master-config.patch)"
 $ master-restart api
 $ master-restart controllers
 ```
-+
-. Then you must modify each individual deployment that you want to monitor as part of your service mesh to enable automatic sidecar injection. Each deployment where you want to enable automatic injection needs to contain the `sidecar.istio.io/inject: "true":` annotation.


I don't necessarily think this belongs here, but this is the only place on the OSSM docs that mentions the annotation. I don't think we can entirely remove this.

This is more to do with how to deploy applications and take advantage of the automatic injection so has nothing to do with installation. It definitely shouldn't be in this section, perhaps we need to introduce a new one covering how to develop applications using automatic injection?

I agree. A separate section would be great. Just want to make sure this makes it into the doc.

kalexand-rh · 2018-10-17T13:40:17Z

@JStickler, @knrc, does this content still need to be merged?

knrc · 2018-10-17T15:21:47Z

@knrc Yes, I made all the requested changes and since then it has been sitting. We are releasing 0.3.0 next week so there will be another PR issued later this week to update to that release.

knrc · 2018-10-17T15:23:08Z

@kalexand-rh Sorry, meant to tag you and not myself :)

kalexand-rh · 2018-10-17T15:23:16Z

@knrc, will you rebase?

knrc · 2018-10-17T15:23:38Z

@kalexand-rh Will it then be merged?

kalexand-rh · 2018-10-17T15:24:15Z

@knrc, yes, I'll merge it. (@vikram-redhat, FYI)

knrc · 2018-10-17T15:25:09Z

@kalexand-rh Great I'll get the rebase done within the hour in that case, just finishing off another task. Thanks very much.

kalexand-rh · 2018-10-17T15:25:51Z

Thanks @knrc! I'll check back after lunch and see if it's ready to go. 😸

knrc · 2018-10-17T16:31:31Z

@kalexand-rh There are now quite a few clashes so it looks as if I'll need to start afresh, rebase is throwing up too many differences. I'll get this done later today.

kalexand-rh · 2018-10-17T16:32:34Z

@knrc, fair enough. Tag me in the new PR.

knrc · 2018-10-17T16:41:28Z

@kalexand-rh I'll still use this PR, GitHub will handle it automatically when I push the updated branch.

vikram-redhat · 2018-10-17T20:50:12Z

@knrc looks like the rebase is required due to the changes introduced by this PR: #12198

kalexand-rh · 2018-10-17T20:57:10Z

@vikram-redhat, Kevin said that he'd fix up the PR soon.

knrc · 2018-10-17T21:11:34Z

@kalexand-rh @vikram-redhat I've been through all the changes and most are already applied to the docs, I've updated this PR to cover the remaining changes.

kalexand-rh · 2018-10-17T21:13:35Z

@knrc, there's a build error:

ERROR: servicemesh-install.adoc: line 75: include file not found:
/home/travis/build/openshift/openshift-docs/drupal-build/openshift-enterprise/servicemesh-install/topics/revision-info.adoc

Will you PTAL?

knrc · 2018-10-17T21:25:06Z

@kalexand-rh I don't understand the error, it's not from a file I modified

servicemesh-install/topics/install-overview.adoc
servicemesh-install/topics/install-prerequisites.adoc
servicemesh-install/topics/install.adoc

knrc · 2018-10-17T21:35:10Z

@kalexand-rh I can find no evidence that file was ever committed to the repository, I'm guessing someone forgot to add it.

knrc · 2018-10-17T21:35:53Z

@JStickler Any ideas?

JStickler · 2018-10-17T21:43:10Z

@knrc The servicemesh-install.adoc file does have a commented out reference to the servicemesh-install.adoc that was there in the templates. Since I'm not using the revisions file, I never checked it in. But that hasn't thrown any errors until now. The only thing I can think of is if your text editor is configured to remove blank spaces at the end of files? Or if the rebase somehow mangled that include being commented out?

knrc · 2018-10-17T21:48:05Z

@JStickler I gave up on the rebase in the end, too many differences. I went through each change one by one and reapplied them to the appropriate location in the docs. This file is not one I modified hence why I'm asking for help :)

knrc · 2018-10-17T21:51:11Z

@JStickler @kalexand-rh @vikram-redhat Looking at the file the contents have not changed in over a month, and still appear to be commented out, so is this an error with the tooling?

vikram-redhat · 2018-10-17T22:11:02Z

@knrc looking..

vikram-redhat · 2018-10-17T22:23:40Z

@knrc @JStickler - yes, it looks like the build is still trying to include the revision history file even though it is part of a commented out block. I do recall this issue coming up about 4 months ago. What is mystifying though, is that it didn't come up before now.

It is unlikely to get fixed (as the eng team responsible for these tools were part of the recent changes), so to get around it, @knrc, could you please comment it out explicitly by adding a // in front of it, or just simply delete that line and add that file as part of this PR?

knrc · 2018-10-17T23:03:39Z

@vikram-redhat done

vikram-redhat · 2018-10-17T23:08:24Z

@knrc - thanks and the build passes. Cool. I will merge as this was already peer reviewed.

vikram-redhat · 2018-10-17T23:29:50Z

/cherrypick enterprise-3.10

openshift-cherrypick-robot · 2018-10-17T23:29:59Z

@vikram-redhat: new pull request created: #12542

In response to this:

/cherrypick enterprise-3.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

vikram-redhat · 2018-10-17T23:31:59Z

/cherrypick enterprise-3.11

openshift-cherrypick-robot · 2018-10-17T23:32:08Z

@vikram-redhat: new pull request created: #12543

In response to this:

/cherrypick enterprise-3.11

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 28, 2018

JStickler reviewed Sep 28, 2018

View reviewed changes

servicemesh-install/topics/install-overview.adoc Outdated Show resolved Hide resolved

kalexand-rh reviewed Oct 1, 2018

View reviewed changes

kalexand-rh added branch/enterprise-3.10 branch/enterprise-3.11 labels Oct 1, 2018

kalexand-rh added this to the Next Release milestone Oct 1, 2018

brian-avery suggested changes Oct 3, 2018

View reviewed changes

brian-avery approved these changes Oct 3, 2018

View reviewed changes

openshift-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 14, 2018

Rebased and updated: MAISTRA-51

ddfcc37

knrc force-pushed the maistra-51 branch from 8803d8c to ddfcc37 Compare October 17, 2018 21:10

openshift-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 17, 2018

openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 17, 2018

Comment out line to appease broken tooling

8bc4cd0

vikram-redhat added the peer-review-done Signifies that the peer review team has reviewed this PR label Oct 17, 2018

vikram-redhat merged commit 6e174f1 into openshift:master Oct 17, 2018

openshift-cherrypick-robot mentioned this pull request Oct 17, 2018

[enterprise-3.10] Some docs updates for the 0.2.0 release #12542

Merged

openshift-cherrypick-robot mentioned this pull request Oct 17, 2018

[enterprise-3.11] Some docs updates for the 0.2.0 release #12543

Merged

Some docs updates for the 0.2.0 release #12233

Some docs updates for the 0.2.0 release #12233

Conversation

knrc commented Sep 28, 2018

kalexand-rh commented Sep 28, 2018

kalexand-rh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018

knrc commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018 via email

vikram-redhat commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018

knrc commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018 • edited

knrc commented Oct 17, 2018

knrc commented Oct 17, 2018

knrc commented Oct 17, 2018

JStickler commented Oct 17, 2018

knrc commented Oct 17, 2018

knrc commented Oct 17, 2018

vikram-redhat commented Oct 17, 2018

vikram-redhat commented Oct 17, 2018

knrc commented Oct 17, 2018

vikram-redhat commented Oct 17, 2018

vikram-redhat commented Oct 17, 2018

openshift-cherrypick-robot commented Oct 17, 2018

vikram-redhat commented Oct 17, 2018

openshift-cherrypick-robot commented Oct 17, 2018

kalexand-rh commented Oct 17, 2018 •

edited