Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: dviejokfs <dviejo@kungfusoftware.es>
  • Loading branch information
dviejokfs committed Aug 4, 2022
1 parent 1c63ed8 commit c30bf8f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
26 changes: 26 additions & 0 deletions website-docs/docs/operator-ui/deploy-operator-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,32 @@ export API_URL=api-operator.<domain>
kubectl hlf operatorapi create --name=operator-api --namespace=default --hosts=$API_URL --ingress-class-name=istio --network-config=./network-config.yaml
```

## Create operator API with authentication
```bash
export API_URL=api-operator.<domain>
export OIDC_ISSUER=https://<your_oidc_issuer>
export OIDC_JWKS=https://<oidc_jwks_url>
kubectl hlf operatorapi create --name=operator-api --namespace=default --hosts=$API_HOST --ingress-class-name=istio \
--oidc-issuer="${OIDC_ISSUER}" --oidc-jwks="${OIDC_JWKS}"
```

## Create operator API with explorer

```bash
export API_URL=api-operator.<domain>
export HLF_SECRET_NAME="k8s-secret"
export HLF_MSPID="<your_mspid>"
export HLF_SECRET_KEY="<network_config_key_secret>" # e.g. networkConfig.yaml
export HLF_USER="<hlf_user>"
kubectl hlf operatorapi create --name=operator-api --namespace=default --hosts=$API_HOST --ingress-class-name=istio \
--hlf-mspid="${HLF_MSPID}" --hlf-secret="${HLF_SECRET_NAME}" --hlf-secret-key="${HLF_SECRET_KEY}" \
--hlf-user="${HLF_USER}"
```

## Update operator API

You can use the same commands with the same parameters, but instead of `create` use `update`

## Delete operator API
In order to delete the operator API:

Expand Down
11 changes: 11 additions & 0 deletions website-docs/docs/operator-ui/deploy-operator-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,19 @@ kubectl hlf operatorui create --name=operator-ui --namespace=default --hosts=$HO
## Create operator UI with authentication

```bash
export HOST=operator-ui.<domain>
export API_URL="http://api-operator.<domain>/graphql"
export OIDC_AUTHORITY="<url_authority>" # without the /.well-known/openid-configuration
export OIDC_CLIENT_ID="<client_id>" # OIDC Client ID for the Operator UI
export OIDC_SCOPE="profile email" # OIDC Scope for the Operator UI
kubectl hlf operatorui create --name=operator-ui --namespace=default --hosts=$HOST --ingress-class-name=istio --api-url=$API_URL \
--oidc-authority="${OIDC_AUTHORITY}" --oidc-client-id="${OIDC_CLIENT_ID}" --oidc-scope="${OIDC_SCOPE}"
```

## Update operator API

You can use the same commands with the same parameters, but instead of `create` use `update`

## Delete operator UI
In order to delete the operator UI:

Expand Down

0 comments on commit c30bf8f

Please sign in to comment.