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

ENDOC-473 remove text EntandoClusterInfrastructure and EntandoComposi… #477

Merged
merged 4 commits into from
Apr 8, 2022

Conversation

jyunmitch
Copy link
Collaborator

…teApp

@jyunmitch jyunmitch requested review from nshaw and Lyd1aCla1r3 April 7, 2022 14:30
@@ -355,7 +289,7 @@ metadata:
name: "test-plugin"
namespace: "my-namespace"
spec:
image: your-org/your-image:4.3.2
image: your-org/your-image
Copy link
Member

Choose a reason for hiding this comment

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

This version still needs to be here. When you specify a Docker/Linux image you have to indicate the user or organization (your-org), the name of image (your-image), and the version of the image (4.3.2, it could also be a tag like latest but a specific version is considered safer.)

This Helm Chart is basically the entry point for installations of Entando 6 on Kubernetes. More detailed instructions
on how to install the Entando 6 Operator are available in our
[installation instructions](../getting-started).
This Helm Chart is basically the entry point for installations of Entando on Kubernetes. More detailed instructions
Copy link
Contributor

Choose a reason for hiding this comment

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

remove "basically"? casual language that implies there's more to it we're not getting into...

for the Operator is absent or has not been created with a wildcard hostname that supports this Keycloak instance's hostname.
* `spec.replicas` - the number of replicas to be made available on the Deployment of this Entando K8S Service.
* `spec.resourceRequirements` - the minimum and maximum [resource allocation](#the-resourcerequirements-specification) for the Entando Kubernetes Service container.
* `spec.resourceRequirements` - the minimum and maximum [resource allocation](#the-resourcerequirements-specification) for the Keycloak Server container.
Copy link
Contributor

Choose a reason for hiding this comment

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

allocations (plural)

@@ -228,7 +161,7 @@ standard images that can be used, but generally we expect our customers to provi
Deployment packages three images into a single Pod: the Entando App Image in question, AppBuilder and Component Manager.
Copy link
Contributor

Choose a reason for hiding this comment

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

super awkward. "deployment packages" reads like "packages" is a noun. "A deployment packages"? to set the scene for a verb?

would remove "in question"; that reads like the entando app image is under interrogation or something. no reason to call it out with a qualifier.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

don't know why Deployment is capitalized, it is "An Entandoapp deployment ..."

changed second part to " the EntandoApp image discussed here, AppBuilder..."

Copy link
Contributor

Choose a reason for hiding this comment

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

ignore my first comment! i'm sure you were confused... i had missed that the sentence didn't start with "Deployment"; i was commenting on "Deployment packages..." not realizing that this was prefaced by "An EntandoApp"

@@ -86,12 +86,11 @@ cluster. After deploying this Keycloak instance, the Entando Operator will creat
the necessary information for subsequent deployment operations to access the Keycloak instance as the Admin user. This
allows the rest of the Entando Kubernetes Controllers to create a Keycloak OpenID Connect (OIDC) client for every HTTP service that
gets deployed. If you already have a Keycloak instance that you want to use, you can skip this custom resource entirely
and simply create the `keycloak-admin-secret' in the operator's namespace as specified in
[this tutorial](../../tutorials/devops/external-id-management.md).
and simply create the `keycloak-admin-secret' in the operator's namespace as specified in the
Copy link
Contributor

Choose a reason for hiding this comment

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

beware of apostrophes masquerading as backticks!!! secret' -> secret`

maybe do a search to make sure that one apostrophe caused all the blue text in this view??

@@ -55,7 +55,7 @@ The Entando Operator itself is also implemented as a Docker Image. You can have
[entando-k8s-controller-coordinator](https://github.com/entando-k8s/entando-k8s-controller-coordinator) project on Github.
Apart from the typical Maven, Java and Docker files, you will also notice the
[entando-k8s-controller-coordinator Helm Chart](https://github.com/entando-k8s/entando-k8s-controller-coordinator/tree/master/charts/entando-k8s-controller-coordinator).
This Helm Chart is basically the entry point for installations of Entando on Kubernetes. More detailed instructions
This Helm Chart is the entry point for installations of Entando on Kubernetes. More detailed instructions
Copy link
Member

Choose a reason for hiding this comment

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

Well, this whole page really needs to be reviewed. We're not using Helm in the install guides anymore. Maybe we can just remove lines 56-58 but leave the "More detailed instructions..." comment. Not sure how if that breaks the page. An alternative is put a post-7.0 ticket in the backlog.


## EntandoApp

An EntandoApp is a Deployment of a Docker image that hosts an Entando and Java based web application. Entando offers two
standard images that can be used, but generally we expect our customers to provide their images here. An EntandoApp
Deployment packages three images into a single Pod: the Entando App Image in question, AppBuilder and Component Manager.
deployment packages three images into a single Pod: the EntandoApp image discussed here, AppBuilder, and Component Manager.
Copy link
Member

Choose a reason for hiding this comment

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

We'll have to fix this when we do the full rewrite. We don't have the 3 containers in 1 pod any more and we'd prefer users not customize the EntandoApp at all.

@nshaw nshaw merged commit 437bf9c into main Apr 8, 2022
@nshaw nshaw deleted the ENDOC-473 branch April 8, 2022 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants