entando/entando-docs

The entando-docs is the repository of the source for building the Entando documentation.

entando-docs's Issues

Adding footer column in page

missing CRDAccessRole.yaml file in CRDs zip

the documentation on http://docs.entando.com/ mentions there is a CRDAccessRole.yaml file, for creating a role that gets around having to set Cluster-Admin role for entando-controllers service account in Openshift
This file seems to be missing from the CRDs zip.

##############################
Grant cluster wide CRD read access only, and full access to Entando Custom resources. This requirement should not be a problem because there is no sensitive information in Entando’s custom resources.

oc create -f CRDAccessRole.yaml

typo in step 2.5

2.5. STEPS WITH A CLUSTER ADMIN ROLE

shouldn't this read
2.5. STEPS WITHOUT A CLUSTER ADMIN ROLE

Setting up database needs more details

For docs/src/main/asciidoc/installation/installation.adoc:

1. The instructions say "Create two databases" but doesn't say what names to use. It should be something like:

Create two databases in your dbms. The database names are strings composed like:

<your-project-name>Port 
<your-project-name>Serv

2. The instructions should specify uncommenting the dependency on the mysql dependency if that database is used.

                    <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>5.1.18</version>
                    </dependency>

Is this a mistake in AppBuilder or in the docs?

In the Mortgage app tutorial, the instructions read:

Assign the page model a code and a name. Codes represent the page model’s unique identifier. The name can be more human readable. For example:
Code: entando-page-purple
Name: Purple - BPM

When I do that, the Appbuilder reports an error:
Code
Code contains invalid characters. Only alphanumeric characters and the underscore '_' are allowed.

Is this an oversight in the documentation, or is the AppBuilder to restrictive? In the former case, I'd be happy to fix it. @joewhite101

Missing steps to deploy blueprint generated services/ui to the Entando 6 platform

The steps to build the first app with entando blueprint (https://es-entando.github.io/build-your-first-app) lacks a linkage with the deployment of the entando platform outline in the preceeding chapters of the doc. My understanding is that the Entando blueprint is used to generate services that act as plugins of the Entando platform, but I miss the steps to install those plugins into the platform, can you provide some hint in the documentation? The documentation is also missing an high level overview of the platform components that are deployed by the K8S Operator.

Specific instructions for K3s, Rancher environments

Hello,

in order to understand better how Entando's open platform works in a K3s environment.
Is it in plan a specific guide for install Entando on Rancher?

Thanks a lot.
Gaetano.

Wrong repository mentioned in Clone and set up section

The Clone and Setup section suggests to clone common-components.git , this should be app-builder.git

Add host config tips/step to reach Entando app locally

Hi there,
I have followed the starting guide (great job!) and I struggled a bit with the hosts config. Until I edited the hosts file I was not be able to reach the Entando login page in my Chrome browser.

I'm on MacOS, I'm not sure if this step is mandatory or if it's related to my configuration. Anyway, I wonder if it could be useful to add a new tips section or a new step to explain that (or maybe I missed something...).

Here an example of what the Host file should contains:

192.168.64.3 quickstart-entando.192.168.64.3.nip.io
192.168.64.3 quickstart-kc-entando.192.168.64.3.nip.io
192.168.64.3 quickstart-eci-entando.192.168.64.3.nip.io

Of course, you have to change the IP value with the one returned in the following command:

sudo kubectl get ingress -n entando -o jsonpath=\
'{.items[2].spec.rules[*].host}{.items[2].spec.rules[*].http.paths[2].path}{"\n"}'

What do you think?

2.5 steps without cluster admin role (step 10)

There's still a part requiring cluster admin role in the documentation under 2.5 - step 10, is there a way around this? Is the entando-operator role enough?

Add the cluster-admin role to the default service account on entando-infra-namespace, required for k8s-service

oc adm policy add-cluster-role-to-user cluster-admin system:serviceaccount:entando-infra-namespace:default

entando application in install-entando fails readiness probe

I'm trying to follow the steps at https://es-entando.github.io/install-entando/#entando-application but the health check on the application fail

Warning  Unhealthy  17m (x4 over 18m)      kubelet, m01       Readiness probe failed: Get http://172.17.0.12:8080/entando-de-app: net/http: request canceled (Client.Timeout exceeded while awaiting headers)
  Warning  Unhealthy  3m37s (x146 over 18m)  kubelet, m01       Readiness probe failed: Get http://172.17.0.12:8083/digital-exchange/actuator/health: dial tcp 172.17.0.12:8083: connect: connection refused

it looks like de starts on the wrong port

2020-03-12 08:20:57.277  INFO 6 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8084 (http) with context path '/digital-exchange'

see attached relevant logs

de.log
server.log

How to remove Entando?

i installed Entando with
https://multipass.run/#install
curl -sfL https://get.entando.org | bash
now I want to remove it from my machine.
how can I do that?
thanks in advancece

Integration test - please ignore

Testing