Skip to content

Commit

Permalink
Merge pull request #511 from entando/ENDOC-501
Browse files Browse the repository at this point in the history
ENDOC-501 In bundler k8ssvcApi renamed to componentManagerApi
  • Loading branch information
nshaw authored May 19, 2022
2 parents 6774a51 + dbe675a commit 0e7db6b
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 24 deletions.
9 changes: 4 additions & 5 deletions vuepress/docs/next/docs/consume/identity-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ Entando Identity Management is based on open source Keycloak. Entando Applicatio

## Logging into your Keycloak Instance

Keycloak is protected by a Secret deployed to your Entando Kubernetes instance. You can query Kubernetes for the Secret's default admin credentials, substituting your environment's namespace and Secret name:
Keycloak is protected by a Secret deployed to your Entando Kubernetes instance. You can query Kubernetes for the Secret's default admin credentials via the following, modifying this command to use your environment's namespace and Secret name:

```
ent kubectl get secret default-sso-in-namespace-admin-secret -n entando -o go-template="{{println}}Username: {{.data.username | base64decode}}{{println}}Password: {{.data.password | base64decode}}{{println}}{{println}}"
kubectl get secret default-sso-in-namespace-admin-secret -n entando -o go-template="{{println}}Username: {{.data.username | base64decode}}{{println}}Password: {{.data.password | base64decode}}{{println}}{{println}}"
```

To find the Secret name, run
To find the Secret name, run the command below and search for the Secret that ends in `namespace-admin-secret`.
```
kubectl get secrets -n YOUR-NAMESPACE
kubectl get secrets -n entando
```
and search for the Secret that ends in `namespace-admin-secret`.

## Authentication
All authentication is powered by Keycloak on Entando. This ensures that a micro frontend can call a microservice with a token available to the client.
Expand Down
8 changes: 4 additions & 4 deletions vuepress/docs/next/docs/reference/entando-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ An `env.json` file to configure the application URLs and client credentials must
For example:
``` json
{
"coreBaseApi": "http://<YOUR-DOMAIN-OR-IP>/entando-de-app",
"k8ssvcApi": "http://<YOUR-DOMAIN-OR-IP>/k8s",
"clientId": "<YOUR-CLIENT-ID>",
"clientSecret": "<YOUR-CLIENT-SECRET>"
"coreBaseApi": "http://YOUR-DOMAIN-OR-IP/entando-de-app",
"componentManagerApi": "http://YOUR-DOMAIN-OR-IP/digital-exchange",
"clientId": "YOUR-CLIENT-ID",
"clientSecret": "YOUR-CLIENT-SECRET"
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Configure a Keycloak client to grant the bundler access to the required Entando

1. Log in to Keycloak using the admin credentials. The URL will be similar to `http://YOUR-HOST-NAME/auth/` and can be verified with the following command:
``` sh
kubectl describe ingress/default-sso-in-namespace
kubectl describe ingress/default-sso-in-namespace-ingress -n entando
```

2. Go to `Clients``Create`
Expand All @@ -43,7 +43,7 @@ kubectl describe ingress/default-sso-in-namespace

6. Click `Save`
7. Go to the `Service Account Roles` tab
8. Select `Client Roles``quickstart-server`
8. Select `Client Roles``quickstart`
9. Select `Available Roles``superuser`
10. Click `Add Selected` to add `superuser` to the `Assigned Roles`. This change will be saved automatically.
11. Go to the `Credentials` tab and copy the `Secret` shown there for use in the next section
Expand All @@ -58,7 +58,7 @@ mkdir testBundle; cd testBundle
``` json
{
"coreBaseApi": "http://YOUR-HOST-NAME/entando-de-app",
"k8ssvcApi": "http://YOUR-HOST-NAME/k8s",
"componentManagerApi": "http://YOUR-HOST-NAME/digital-exchange",
"clientId": "YOUR-CLIENT-ID",
"clientSecret": "YOUR-CLIENT-SECRET"
}
Expand Down
9 changes: 4 additions & 5 deletions vuepress/docs/v7.0/docs/consume/identity-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ Entando Identity Management is based on open source Keycloak. Entando Applicatio

## Logging into your Keycloak Instance

Keycloak is protected by a Secret deployed to your Entando Kubernetes instance. You can query Kubernetes for the Secret's default admin credentials, substituting your environment's namespace and Secret name:
Keycloak is protected by a Secret deployed to your Entando Kubernetes instance. You can query Kubernetes for the Secret's default admin credentials via the following, modifying this command to use your environment's namespace and Secret name:

```
ent kubectl get secret default-sso-in-namespace-admin-secret -n entando -o go-template="{{println}}Username: {{.data.username | base64decode}}{{println}}Password: {{.data.password | base64decode}}{{println}}{{println}}"
kubectl get secret default-sso-in-namespace-admin-secret -n entando -o go-template="{{println}}Username: {{.data.username | base64decode}}{{println}}Password: {{.data.password | base64decode}}{{println}}{{println}}"
```

To find the Secret name, run
To find the Secret name, run the command below and search for the Secret that ends in `namespace-admin-secret`.
```
kubectl get secrets -n YOUR-NAMESPACE
kubectl get secrets -n entando
```
and search for the Secret that ends in `namespace-admin-secret`.

## Authentication
All authentication is powered by Keycloak on Entando. This ensures that a micro frontend can call a microservice with a token available to the client.
Expand Down
8 changes: 4 additions & 4 deletions vuepress/docs/v7.0/docs/reference/entando-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ An `env.json` file to configure the application URLs and client credentials must
For example:
``` json
{
"coreBaseApi": "http://<YOUR-DOMAIN-OR-IP>/entando-de-app",
"k8ssvcApi": "http://<YOUR-DOMAIN-OR-IP>/k8s",
"clientId": "<YOUR-CLIENT-ID>",
"clientSecret": "<YOUR-CLIENT-SECRET>"
"coreBaseApi": "http://YOUR-DOMAIN-OR-IP/entando-de-app",
"componentManagerApi": "http://YOUR-DOMAIN-OR-IP/digital-exchange",
"clientId": "YOUR-CLIENT-ID",
"clientSecret": "YOUR-CLIENT-SECRET"
}
```

Expand Down
1 change: 1 addition & 0 deletions vuepress/docs/v7.0/docs/releases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ The [Entando Hub](../getting-started/landing-page.md#entando-hub) is a new [Enta
* It's now possible to generate system-level bundles (see [ECR](#entando-component-repository-ecr)).
* Extract/download have been optimized to only touch the relevant resources.
* Libraries have been updated for reliability and security.
* Installed plugins are now extracted via the component manager API. The k8s-service API has been deprecated but is preserved for backwards compatibility.

### EOL Kubernetes Versions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Configure a Keycloak client to grant the bundler access to the required Entando

1. Log in to Keycloak using the admin credentials. The URL will be similar to `http://YOUR-HOST-NAME/auth/` and can be verified with the following command:
``` sh
kubectl describe ingress/default-sso-in-namespace
kubectl describe ingress/default-sso-in-namespace-ingress -n entando
```

2. Go to `Clients``Create`
Expand All @@ -43,7 +43,7 @@ kubectl describe ingress/default-sso-in-namespace

6. Click `Save`
7. Go to the `Service Account Roles` tab
8. Select `Client Roles``quickstart-server`
8. Select `Client Roles``quickstart`
9. Select `Available Roles``superuser`
10. Click `Add Selected` to add `superuser` to the `Assigned Roles`. This change will be saved automatically.
11. Go to the `Credentials` tab and copy the `Secret` shown there for use in the next section
Expand All @@ -58,7 +58,7 @@ mkdir testBundle; cd testBundle
``` json
{
"coreBaseApi": "http://YOUR-HOST-NAME/entando-de-app",
"k8ssvcApi": "http://YOUR-HOST-NAME/k8s",
"componentManagerApi": "http://YOUR-HOST-NAME/digital-exchange",
"clientId": "YOUR-CLIENT-ID",
"clientSecret": "YOUR-CLIENT-SECRET"
}
Expand Down

0 comments on commit 0e7db6b

Please sign in to comment.