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

MAISTRA-817 document networking configuration details #92

Merged
merged 2 commits into from
Sep 3, 2019

Conversation

rcernich
Copy link
Contributor

Signed-off-by: rcernich rcernich@redhat.com

@@ -12,6 +12,22 @@ ways. The modifications to Maistra are sometimes necessary to resolve issues,
provide additional features, or to handle differences when deploying on
OpenShift or OKD.

=== Multitenancy

Copy link
Contributor

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 put the networking differences in the installation details instead? I see this comparison section as a high level 30 second sales pitch of why someone should use Maistra instead of Istio, not necessarily something someone will read through when trying to understand how to use the product.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is not really marketing speak as it is though ;) Let's have the sales pitch somewhere else (index?) and keep this to document technical differences

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree :) Need to reword index. I'm thinking something similar to:

Maistra is an opinionated version of Istio that builds on top of the functionality you expect from OpenShift. Among the changes that Maistra includes are:

  • multi-tenant control plane to support multiple cluster users
  • Removal of cluster scoped resources
  • No required special privileges
  • Addition of templates in order to support reusable configurations

That said, that I've found, we're the only project with a "differences" page, and I think this page should eventually go away.


NOTE: This also restricts ingress to only member projects. If ingress from non-member projects is required, you need to create a `NetworkPolicy` to allow that traffic through.

* `Multitenant`: Maistra joins the `NetNamespace` for each member project to the `NetNamespace` of the control plane project (for example, invoking `oc adm pod-network join-projects --to control-plane-project member-project`). If you remove a member from the mesh, its `NetNamespace` is isolated from the control plane (for example, invoking `oc adm pod-network isolate-projects member-project`).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should now be <control-plane-project> and <member-project>, right? Not entirely sure, as this is not really a copy-paste example

Copy link
Contributor

Choose a reason for hiding this comment

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

In an example, it's fine to subsitute an actual namespace. But in documentation this should be <control-plane-project>. In this case, this is documentation so should be <control-plane-project>

Markup in command syntax Description Substitute value in Example block
<project> Name of project myproject
<app> Name of an application myapp

@@ -12,6 +12,22 @@ ways. The modifications to Maistra are sometimes necessary to resolve issues,
provide additional features, or to handle differences when deploying on
OpenShift or OKD.

=== Multitenancy

The main difference between a multi-tenant installation and a cluster-wide installation is the scope of privileges used by the control plane deployments, for example, Galley and Pilot. The components no longer use cluster-scoped Role Based Access Control (RBAC) `ClusterRoleBinding`, but rely on project-scoped RBAC.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should either be:

The components no longer use cluster-scoped Role Based Access Control (RBAC) (ClusterRoleBinding)

or

The components no longer use the cluster-scoped Role Based Access Control (RBAC) resource ClusterRoleBinding

@brian-avery
Copy link
Contributor

both @dgn and @jwendell seem fine with this in the comparison doc so fix the style issues and I'll give this an approval. We can fix the location of the content after GA.

Signed-off-by: rcernich <rcernich@redhat.com>
@mergify mergify bot merged commit 3c96b6c into maistra:maistra-1.0 Sep 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants