Skip to content

Commit

Permalink
[docs] use dashes in nip.io names
Browse files Browse the repository at this point in the history
  • Loading branch information
rconway committed Sep 18, 2023
1 parent f66d2d7 commit c6c05c4
Show file tree
Hide file tree
Showing 16 changed files with 102 additions and 94 deletions.
8 changes: 4 additions & 4 deletions docs/cluster/cluster-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,14 @@ auth:
ingress:
enabled: true
ingressClassName: nginx
hostname: minio-console.192.168.49.2.nip.io
hostname: minio-console.192-168-49-2.nip.io
annotations:
nginx.ingress.kubernetes.io/proxy-body-size: 0m
apiIngress:
enabled: true
ingressClassName: nginx
hostname: minio.192.168.49.2.nip.io
hostname: minio.192-168-49-2.nip.io
annotations:
nginx.ingress.kubernetes.io/proxy-body-size: 0m
Expand All @@ -201,8 +201,8 @@ In response to the prompts, the following configuration selections are applicabl
Access Key: eoepca
Secret Key: changeme
Default Region: us-east-1
S3 Endpoint: minio.192.168.49.2.nip.io
DNS-style bucket+hostname:port template for accessing a bucket: minio.192.168.49.2.nip.io
S3 Endpoint: minio.192-168-49-2.nip.io
DNS-style bucket+hostname:port template for accessing a bucket: minio.192-168-49-2.nip.io
Encryption password:
Path to GPG program: /usr/bin/gpg
Use HTTPS protocol: False
Expand Down
32 changes: 16 additions & 16 deletions docs/eoepca/ades.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ workflowExecutor:
STAGEIN_AWS_REGION: RegionOne
# Stage-out to minio S3
# (use this if the ADES is not configured to stage-out to the Workspace)
STAGEOUT_AWS_SERVICEURL: http://minio.192.168.49.2.nip.io
STAGEOUT_AWS_SERVICEURL: http://minio.192-168-49-2.nip.io
STAGEOUT_AWS_ACCESS_KEY_ID: eoepca
STAGEOUT_AWS_SECRET_ACCESS_KEY: changeme
STAGEOUT_AWS_REGION: us-east-1
Expand All @@ -55,13 +55,13 @@ ingress:
kubernetes.io/ingress.class: nginx
ingress.kubernetes.io/ssl-redirect: "false"
hosts:
- host: ades.192.168.49.2.nip.io
- host: ades.192-168-49-2.nip.io
paths:
- path: /
pathType: ImplementationSpecific
tls:
- hosts:
- ades.192.168.49.2.nip.io
- ades.192-168-49-2.nip.io
secretName: ades-tls
```
Expand Down Expand Up @@ -100,8 +100,8 @@ workflowExecutor:
...
useResourceManager: "true"
resourceManagerWorkspacePrefix: "guide-user"
resourceManagerEndpoint: "https://workspace-api.192.168.49.2.nip.io"
platformDomain: "https://auth.192.168.49.2.nip.io"
resourceManagerEndpoint: "https://workspace-api.192-168-49-2.nip.io"
platformDomain: "https://auth.192-168-49-2.nip.io"
...
```

Expand All @@ -125,7 +125,7 @@ The `resource-guard` must be configured with the values applicable to the ADES f
#---------------------------------------------------------------------------
global:
context: ades
domain: 192.168.49.2.nip.io
domain: 192-168-49-2.nip.io
nginxIp: 192.168.49.2
certManager:
clusterIssuer: letsencrypt-production
Expand Down Expand Up @@ -171,7 +171,7 @@ uma-user-agent:
credentialsSecretName: "proc-client"
logging:
level: "info"
unauthorizedResponse: 'Bearer realm="https://portal.192.168.49.2.nip.io/oidc/authenticate/"'
unauthorizedResponse: 'Bearer realm="https://portal.192-168-49-2.nip.io/oidc/authenticate/"'
openAccess: false
insecureTlsSkipVerify: true
```
Expand Down Expand Up @@ -213,9 +213,9 @@ data:
client.yaml: Y2xpZW50LWlkOiBhOThiYTY2ZS1lODc2LTQ2ZTEtODYxOS01ZTEzMGEzOGQxYTQKY2xpZW50LXNlY3JldDogNzM5MTRjZmMtYzdkZC00YjU0LTg4MDctY2UxN2MzNjQ1NTU4
```

The client credentials are obtained by registration of a client at the login service web interface - e.g. https://auth.192.168.49.2.nip.io. In addition there is a helper script that can be used to create a basic client and obtain the credentials, as described in [section Resource Protection](../resource-protection/#client-registration)...
The client credentials are obtained by registration of a client at the login service web interface - e.g. https://auth.192-168-49-2.nip.io. In addition there is a helper script that can be used to create a basic client and obtain the credentials, as described in [section Resource Protection](../resource-protection/#client-registration)...
```bash
./deploy/bin/register-client auth.192.168.49.2.nip.io "Resource Guard" | tee client.yaml
./deploy/bin/register-client auth.192-168-49-2.nip.io "Resource Guard" | tee client.yaml
```

## ADES Usage Samples
Expand All @@ -234,7 +234,7 @@ This section includes some sample requests to test the deployed ADES.
List available processes.

```
curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/wps3/processes' \
curl --location --request GET 'https://ades.192-168-49-2.nip.io/eric/wps3/processes' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json'
```
Expand All @@ -244,7 +244,7 @@ curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/wps3/proces
Deploy the sample application `snuggs`.
```
curl --location --request POST 'https://ades.192.168.49.2.nip.io/eric/wps3/processes' \
curl --location --request POST 'https://ades.192-168-49-2.nip.io/eric/wps3/processes' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
Expand Down Expand Up @@ -283,7 +283,7 @@ curl --location --request POST 'https://ades.192.168.49.2.nip.io/eric/wps3/proce
Get details for a deployed process.
```
curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/wps3/processes/snuggs-0_3_0' \
curl --location --request GET 'https://ades.192-168-49-2.nip.io/eric/wps3/processes/snuggs-0_3_0' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json'
```
Expand All @@ -293,7 +293,7 @@ curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/wps3/proces
Execute a process with supplied parameterisation.
```
curl --location --request POST 'https://ades.192.168.49.2.nip.io/eric/wps3/processes/snuggs-0_3_0/jobs' \
curl --location --request POST 'https://ades.192-168-49-2.nip.io/eric/wps3/processes/snuggs-0_3_0/jobs' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
Expand Down Expand Up @@ -339,7 +339,7 @@ curl --location --request POST 'https://ades.192.168.49.2.nip.io/eric/wps3/proce
Once a processes execution has been initiated then its progress can monitored via a job-specific URL that is returned in the HTTP response headers of the execute request.
```
curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/watchjob/processes/snuggs-0_3_0/jobs/2e0fabf4-4ed6-11ec-b857-626a98159388' \
curl --location --request GET 'https://ades.192-168-49-2.nip.io/eric/watchjob/processes/snuggs-0_3_0/jobs/2e0fabf4-4ed6-11ec-b857-626a98159388' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json'
```
Expand All @@ -349,7 +349,7 @@ curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/watchjob/pr
Once the job execution has completed, then the results can be obtained.
```
curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/watchjob/processes/snuggs-0_3_0/jobs/2e0fabf4-4ed6-11ec-b857-626a98159388/result' \
curl --location --request GET 'https://ades.192-168-49-2.nip.io/eric/watchjob/processes/snuggs-0_3_0/jobs/2e0fabf4-4ed6-11ec-b857-626a98159388/result' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json'
```
Expand All @@ -359,7 +359,7 @@ curl --location --request GET 'https://ades.192.168.49.2.nip.io/eric/watchjob/pr
A process can be deleted (undeployed).
```
curl --location --request DELETE 'https://ades.192.168.49.2.nip.io/eric/wps3/processes/snuggs-0_3_0' \
curl --location --request DELETE 'https://ades.192-168-49-2.nip.io/eric/wps3/processes/snuggs-0_3_0' \
--header 'X-User-Id: <user-id-token>' \
--header 'Accept: application/json'
```
Expand Down
8 changes: 4 additions & 4 deletions docs/eoepca/container-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ expose:
nginx.ingress.kubernetes.io/proxy-body-size: "0"

hosts:
core: harbor.192.168.49.2.nip.io
notary: harbor-notary.192.168.49.2.nip.io
core: harbor.192-168-49-2.nip.io
notary: harbor-notary.192-168-49-2.nip.io

persistence:
persistentVolumeClaim:
Expand All @@ -49,7 +49,7 @@ persistence:
trivy:
storageClass: standard

externalURL: https://harbor.192.168.49.2.nip.io
externalURL: https://harbor.192-168-49-2.nip.io
# initial password for logging in with user "admin"
harborAdminPassword: "changeme"

Expand All @@ -68,7 +68,7 @@ notary:

## Container Registry Usage

After deployemnt Harbor is accessible via its [web interface](https://harbor.192.168.49.2.nip.io/) at `https://harbor.<domain>/`<br>e.g. [https://harbor.192.168.49.2.nip.io/](https://harbor.192.168.49.2.nip.io/).
After deployemnt Harbor is accessible via its [web interface](https://harbor.192-168-49-2.nip.io/) at `https://harbor.<domain>/`<br>e.g. [https://harbor.192-168-49-2.nip.io/](https://harbor.192-168-49-2.nip.io/).

Login as the admin user with the password specified in the helm values.

Expand Down
18 changes: 9 additions & 9 deletions docs/eoepca/data-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ global:
nginx.ingress.kubernetes.io/enable-cors: "true"
cert-manager.io/cluster-issuer: letsencrypt-production
hosts:
- host: data-access.192.168.49.2.nip.io
- host: data-access.192-168-49-2.nip.io
tls:
- hosts:
- data-access.192.168.49.2.nip.io
- data-access.192-168-49-2.nip.io
secretName: data-access-tls
storage:
data:
Expand All @@ -65,8 +65,8 @@ global:
validate_bucket_name: false
cache:
type: S3
endpoint_url: "http://minio.192.168.49.2.nip.io"
host: "minio.192.168.49.2.nip.io"
endpoint_url: "http://minio.192-168-49-2.nip.io"
host: "minio.192-168-49-2.nip.io"
access_key_id: xxx
secret_access_key: xxx
region: us-east-1
Expand All @@ -75,7 +75,7 @@ global:
title: EOEPCA Data Access Service developed by EOX
abstract: EOEPCA Data Access Service developed by EOX
header: "EOEPCA Data Access View Server (VS) Client powered by <a href=\"//eox.at\"><img src=\"//eox.at/wp-content/uploads/2017/09/EOX_Logo.svg\" alt=\"EOX\" style=\"height:25px;margin-left:10px\"/></a>"
url: https://data-access.192.168.49.2.nip.io/ows
url: https://data-access.192-168-49-2.nip.io/ows
layers:
# see section 'Data-layer Configuration'
collections:
Expand Down Expand Up @@ -318,7 +318,7 @@ The `resource-guard` must be configured with the values applicable to the Data A
#---------------------------------------------------------------------------
global:
context: data-access
domain: 192.168.49.2.nip.io
domain: 192-168-49-2.nip.io
nginxIp: 192.168.49.2
certManager:
clusterIssuer: letsencrypt-production
Expand Down Expand Up @@ -373,7 +373,7 @@ uma-user-agent:
credentialsSecretName: "resman-client"
logging:
level: "info"
unauthorizedResponse: 'Bearer realm="https://portal.192.168.49.2.nip.io/oidc/authenticate/"'
unauthorizedResponse: 'Bearer realm="https://portal.192-168-49-2.nip.io/oidc/authenticate/"'
openAccess: false
insecureTlsSkipVerify: true
```
Expand Down Expand Up @@ -415,9 +415,9 @@ data:
client.yaml: Y2xpZW50LWlkOiBhOThiYTY2ZS1lODc2LTQ2ZTEtODYxOS01ZTEzMGEzOGQxYTQKY2xpZW50LXNlY3JldDogNzM5MTRjZmMtYzdkZC00YjU0LTg4MDctY2UxN2MzNjQ1NTU4
```

The client credentials are obtained by registration of a client at the login service web interface - e.g. https://auth.192.168.49.2.nip.io. In addition there is a helper script that can be used to create a basic client and obtain the credentials, as described in [section Resource Protection](../resource-protection/#client-registration)...
The client credentials are obtained by registration of a client at the login service web interface - e.g. https://auth.192-168-49-2.nip.io. In addition there is a helper script that can be used to create a basic client and obtain the credentials, as described in [section Resource Protection](../resource-protection/#client-registration)...
```bash
./deploy/bin/register-client auth.192.168.49.2.nip.io "Resource Guard" | tee client.yaml
./deploy/bin/register-client auth.192-168-49-2.nip.io "Resource Guard" | tee client.yaml
```

## Data Access Usage
Expand Down
12 changes: 6 additions & 6 deletions docs/eoepca/login-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ helm install --version 1.2.1 --values login-service-values.yaml login-service eo

At minimum, values for the following attributes should be specified:

* Public hostname of the Authorization Server, e.g. `auth.192.168.49.2.nip.io`
* Public hostname of the Authorization Server, e.g. `auth.192-168-49-2.nip.io`
* IP Address of the public facing reverse proxy (Nginx Ingress Controller), e.g. `192.168.49.2`
* Kubernetes `namespace` for the login-service components
* Initial password for the admin user<br>
Expand All @@ -28,14 +28,14 @@ At minimum, values for the following attributes should be specified:
Example `login-service-values.yaml`...
```yaml
global:
domain: auth.192.168.49.2.nip.io
domain: auth.192-168-49-2.nip.io
nginxIp: 192.168.49.2
namespace: um
volumeClaim:
name: eoepca-userman-pvc
create: false
config:
domain: auth.192.168.49.2.nip.io
domain: auth.192-168-49-2.nip.io
adminPass: Chang3me!
ldapPass: Chang3me!
volumeClaim:
Expand All @@ -54,16 +54,16 @@ nginx:
annotations:
cert-manager.io/cluster-issuer: letsencrypt-production
hosts:
- auth.192.168.49.2.nip.io
- auth.192-168-49-2.nip.io
tls:
- hosts:
- auth.192.168.49.2.nip.io
- auth.192-168-49-2.nip.io
secretName: login-service-tls
```
## Login Service Usage
Once the deployment has been completed successfully, the Login Service is accessed at the endpoint `https://auth.<domain>/`, configured by your domain - e.g. [https://auth.192.168.49.2.nip.io/](https://auth.192.168.49.2.nip.io/).
Once the deployment has been completed successfully, the Login Service is accessed at the endpoint `https://auth.<domain>/`, configured by your domain - e.g. [https://auth.192-168-49-2.nip.io/](https://auth.192-168-49-2.nip.io/).

Login as the `admin` user with the credentials configured in the helm values - ref. `adminPass` / `ldapPass`.

Expand Down
16 changes: 8 additions & 8 deletions docs/eoepca/pde.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ hub:
pvc:
storageClassName: standard
extraEnv:
OAUTH_CALLBACK_URL: "https://pde.192.168.49.2.nip.io/hub/oauth_callback"
OAUTH2_USERDATA_URL: "https://auth.192.168.49.2.nip.io/oxauth/restv1/userinfo"
OAUTH2_TOKEN_URL: "https://auth.192.168.49.2.nip.io/oxauth/restv1/token"
OAUTH2_AUTHORIZE_URL: "https://auth.192.168.49.2.nip.io/oxauth/restv1/authorize"
OAUTH_LOGOUT_REDIRECT_URL: "https://auth.192.168.49.2.nip.io/oxauth/restv1/end_session?post_logout_redirect_uri=https://pde.192.168.49.2.nip.io"
OAUTH_CALLBACK_URL: "https://pde.192-168-49-2.nip.io/hub/oauth_callback"
OAUTH2_USERDATA_URL: "https://auth.192-168-49-2.nip.io/oxauth/restv1/userinfo"
OAUTH2_TOKEN_URL: "https://auth.192-168-49-2.nip.io/oxauth/restv1/token"
OAUTH2_AUTHORIZE_URL: "https://auth.192-168-49-2.nip.io/oxauth/restv1/authorize"
OAUTH_LOGOUT_REDIRECT_URL: "https://auth.192-168-49-2.nip.io/oxauth/restv1/end_session?post_logout_redirect_uri=https://pde.192-168-49-2.nip.io"
STORAGE_CLASS: "standard"
ingress:
enabled: true
annotations:
cert-manager.io/cluster-issuer: letsencrypt-production
hosts:
- host: pde.192.168.49.2.nip.io
- host: pde.192-168-49-2.nip.io
paths:
- path: /
tls:
- hosts:
- pde.192.168.49.2.nip.io
- pde.192-168-49-2.nip.io
secretName: pde-tls
```
Expand All @@ -63,7 +63,7 @@ kubectl -n pde create secret generic jupyterhub-secrets \
## PDE Usage
The PDE is accessed at the endpoint `https://pde.<domain>/`, configured by your domain - e.g. [https://pde.192.168.49.2.nip.io/](https://pde.192.168.49.2.nip.io/).
The PDE is accessed at the endpoint `https://pde.<domain>/`, configured by your domain - e.g. [https://pde.192-168-49-2.nip.io/](https://pde.192-168-49-2.nip.io/).
## Additional Information
Expand Down
4 changes: 2 additions & 2 deletions docs/eoepca/pdp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ helm install --version 1.1.6 --values pdp-values.yaml pdp eoepca/pdp-engine

At minimum, values for the following attributes should be specified:

* Public hostname of the Authorization Server, e.g. `auth.192.168.49.2.nip.io`
* Public hostname of the Authorization Server, e.g. `auth.192-168-49-2.nip.io`
* IP Address of the public facing reverse proxy (Nginx Ingress Controller), e.g. `192.168.49.2`
* Name of Persistent Volume Claim for `pdp-engine` persistence, e.g. `eoepca-userman-pvc`<br>
_The boolen value `volumeClaim.create` can be used for the PVC to be created by the helm release. This creates a volume of type `host-path` and, hence, is only useful for single-node development usage._
Expand All @@ -25,7 +25,7 @@ Example `pdp-values.yaml`...
```yaml
global:
nginxIp: 192.168.49.2
domain: auth.192.168.49.2.nip.io
domain: auth.192-168-49-2.nip.io
volumeClaim:
name: eoepca-userman-pvc
create: false
Expand Down
Loading

0 comments on commit c6c05c4

Please sign in to comment.