Skip to content

Commit e4eb12a

Browse files
asanvaqCopilotalesancor1
authored
docs: migrate docs to v2 identity-platform-admin-ui (#942)
* docs: migrate docs to v2 identity-platform-admin-ui * docs: fix error * docs: update based on feedback, adding default values and improving formatting Co-authored-by: Copilot <copilot@github.com> * docs: update defaults Co-authored-by: Copilot <copilot@github.com> * docs: fix errors * docs: remove unnecessary defaults * docs: apply suggestions from code review Co-authored-by: Alejandro Santisteban <alex.santisteban@canonical.com> --------- Co-authored-by: Copilot <copilot@github.com> Co-authored-by: Alejandro Santisteban <alex.santisteban@canonical.com>
1 parent 985899c commit e4eb12a

1 file changed

Lines changed: 121 additions & 121 deletions

File tree

‎oci/identity-platform-admin-ui/documentation.yaml‎

Lines changed: 121 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,139 @@
1-
version: 1
1+
version: 2
22
application: identity-platform-admin-ui
3-
is_chiselled: True
43
description: |
54
Canonical IAM Admin UI is a component that allows you to interact with the components
65
that are part of the Identity Platform solution.
7-
8-
It provides a set of API to view,modify and delete resources on Ory Kratos, Ory Hydra
6+
7+
It provides a set of API to view,modify and delete resources on Ory Kratos, Ory Hydra
98
Ory Oathkeeper and OpenFGA
9+
website: https://github.com/canonical/identity-platform-admin-ui
10+
issues: https://github.com/canonical/identity-platform-admin-ui/issues
11+
source-code: https://github.com/canonical/identity-platform-admin-ui
1012

11-
For further information check our repository on Github https://github.com/canonical/identity-platform-admin-ui
1213
docker:
13-
parameters:
14-
- -p 8080:8080
15-
access: Access the API at `http://localhost:8080`.
16-
parameters:
17-
- type: -e
18-
value: 'TRACING_ENABLED=true'
19-
description: Tracing enablement.
20-
- type: -e
21-
value: 'OTEL_GRPC_ENDPOINT=tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4317'
22-
description: Tracing server GRPC endpoint, has priority on OTEL_HTTP_ENDPOINT.
23-
- type: -e
24-
value: 'OTEL_HTTP_ENDPOINT=http://tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4318'
25-
description: Tracing server HTTP endpoint.
26-
- type: -e
27-
value: 'MFA_ENABLED="true"'
28-
description: Enable MFA validation on logins.
29-
- type: -e
30-
value: 'HYDRA_ADMIN_URL=http://hydra.io:4445'
31-
description: Hydra Admin API URL, used to manage clients
32-
- type: -e
33-
value: 'KRATOS_ADMIN_URL=http://kratos.io:4434'
34-
description: Kratos Admin API URL, used to manage identities
35-
- type: -e
36-
value: 'KRATOS_PUBLIC_URL=http://kratos.io:4433'
37-
description: Kratos Public API URL, used to manage identities
38-
- type: -e
39-
value: 'OATHKEEPER_PUBLIC_URL=http://oathkeeper.io:4455'
40-
description: Oathkeeper Public API URL, used to manage rules
41-
- type: -e
42-
value: 'BASE_URL=https://iam.io/dev/path'
43-
description: Public URL Login UI will be served from.
44-
- type: -e
45-
value: 'ACCESS_TOKEN_VERIFICATION_STRATEGY=jwks'
14+
parameters: >-
15+
-p 8080:8080
16+
run_conclusion: |
17+
Access the API at `http://localhost:8080`.
18+
19+
config:
20+
'`OTEL_GRPC_ENDPOINT`':
21+
type: env
22+
description: Tracing server GRPC endpoint, e.g., `tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4317`. Has priority on OTEL_HTTP_ENDPOINT.
23+
'`OTEL_HTTP_ENDPOINT`':
24+
type: env
25+
description: Tracing server HTTP endpoint, e.g., `http://tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4318`.
26+
'`TRACING_ENABLED`':
27+
type: env
28+
description: Tracing enablement, e.g., `true`.
29+
'`LOG_FILE`':
30+
type: env
31+
description: Destination file for logs, e.g., `log.txt`.
32+
'`LOG_LEVEL`':
33+
type: env
34+
description: Log level, e.g., `error`.
35+
'`HYDRA_ADMIN_URL`':
36+
type: env
37+
description: Hydra Admin API URL, used to manage clients, e.g., `http://hydra.io:4445`.
38+
'`KRATOS_ADMIN_URL`':
39+
type: env
40+
description: Kratos Admin API URL, used to manage identities, e.g., `http://kratos.io:4434`.
41+
'`KRATOS_PUBLIC_URL`':
42+
type: env
43+
description: Kratos Public API URL, used to manage identities, e.g., `http://kratos.io:4433`.
44+
'`OATHKEEPER_PUBLIC_URL`':
45+
type: env
46+
description: Oathkeeper Public API URL, used to manage rules.
47+
'`BASE_URL`':
48+
type: env
49+
description: Public URL Login UI will be served from, e.g., `https://iam.io/dev/path`.
50+
'`ACCESS_TOKEN_VERIFICATION_STRATEGY`':
51+
type: env
4652
description: Strategy used to verify JWT tokens.
47-
- type: -e
48-
value: 'AUTHENTICATION_ENABLED="true"'
53+
'`AUTHENTICATION_ENABLED`':
54+
type: env
4955
description: Authentication enable flag.
50-
- type: -e
51-
value: 'AUTHORIZATION_ENABLED="true"'
56+
default: '"false"'
57+
'`AUTHORIZATION_ENABLED`':
58+
type: env
5259
description: Authorization enable flag.
53-
- type: -e
54-
value: 'CONTEXT_PATH=/dev/path'
60+
default: '"false"'
61+
'`CONTEXT_PATH`':
62+
type: env
5563
description: Path needed by the UI to work behind an ingress proxy.
56-
- type: -e
57-
value: 'IDP_CONFIGMAP_NAME=providers'
64+
'`IDP_CONFIGMAP_NAME`':
65+
type: env
5866
description: Name of kubernetes configmap where Kratos IDP are configured.
59-
- type: -e
60-
value: 'IDP_CONFIGMAP_NAMESPACE=default'
67+
'`IDP_CONFIGMAP_NAMESPACE`':
68+
type: env
6169
description: Namespace of kubernetes configmap where Kratos IDP are configured.
62-
- type: -e
63-
value: 'RULES_CONFIGMAP_NAME=rules'
70+
'`RULES_CONFIGMAP_NAME`':
71+
type: env
6472
description: Name of kubernetes configmap where Oathkeeper rules are configured.
65-
- type: -e
66-
value: 'RULES_CONFIGMAP_NAMESPACE=default'
73+
'`RULES_CONFIGMAP_NAMESPACE`':
74+
type: env
6775
description: Namespace of kubernetes configmap where Oathkeeper rules are configured.
68-
- type: -e
69-
value: 'RULES_CONFIGMAP_FILENAME=rules.yaml'
76+
'`RULES_CONFIGMAP_FILENAME`':
77+
type: env
7078
description: Name of the file where Oathkeeper rules are configured.
71-
- type: -e
72-
value: 'SCHEMAS_CONFIGMAP_NAME=schemas'
79+
'`SCHEMAS_CONFIGMAP_NAME`':
80+
type: env
7381
description: Name of kubernetes configmap where Kratos identity schemas are configured.
74-
- type: -e
75-
value: 'SCHEMAS_CONFIGMAP_NAMESPACE=default'
82+
'`SCHEMAS_CONFIGMAP_NAMESPACE`':
83+
type: env
7684
description: Namespace of kubernetes configmap where Kratos identity schemas are configured.
77-
- type: -e
78-
value: 'MAIL_FROM_ADDRESS=iam@canonical.com'
79-
description: Email sender
80-
- type: -e
81-
value: 'MAIL_HOST=smtp.io'
82-
description: SMPT server host
83-
- type: -e
84-
value: 'MAIL_PASSWORD="***********************************"'
85-
description: SMTP password
86-
- type: -e
87-
value: 'MAIL_PORT="1025"'
88-
description: SMTP server port
89-
- type: -e
90-
value: 'MAIL_USERNAME="***********************************"'
91-
description: SMTP password
92-
- type: -e
93-
value: 'OAUTH2_AUTH_COOKIES_ENCRYPTION_KEY="***********************************"'
94-
description: Key used to encrypt authentication cookies
95-
- type: -e
96-
value: 'OAUTH2_CLIENT_ID=***********************************'
97-
description: OAuth2 client ID, needed for OIDC authentication
98-
- type: -e
99-
value: 'OAUTH2_CLIENT_SECRET=***********************************'
100-
description: OAuth2 client secret, needed for OIDC authentication
101-
- type: -e
102-
value: 'OAUTH2_CODEGRANT_SCOPES=openid,email,profile,offline_access'
103-
description: OAuth2 scopes needed by the application, needed for OIDC authentication
104-
- type: -e
105-
value: 'OAUTH2_REDIRECT_URI=https://iam..io/dev/api/v0/auth/callback'
106-
description: OAuth2 redirect uri where /api/v0/auth/callback is the endpoint used by the application, needed for OIDC authentication
107-
- type: -e
108-
value: 'OIDC_ISSUER=https://iam.dev.canonical.com/stg-identity-jaas-dev-hydra'
109-
description: OAuth2 server issuer
110-
- type: -e
111-
value: 'OPENFGA_API_HOST=openfga:8443'
112-
description: OpenFGA server address
113-
- type: -e
114-
value: 'OPENFGA_API_SCHEME=http'
115-
description: OpenFGA server scheme
116-
- type: -e
117-
value: 'OPENFGA_API_TOKEN=***********************************'
118-
description: OpenFGA server API token, needed for authentication to the server
119-
- type: -e
120-
value: 'OPENFGA_AUTHORIZATION_MODEL_ID=***********************************'
121-
description: OpenFGA model ID
122-
- type: -e
123-
value: 'OPENFGA_STORE_ID=***********************************'
124-
description: OpenFGA store ID
125-
- type: -e
126-
value: 'LOG_FILE=log.txt'
127-
description: Destination file for logs.
128-
- type: -e
129-
value: 'LOG_LEVEL=error'
130-
description: Log level.
131-
- type: -p
132-
value: '8080:8080'
133-
description: Server API port.
134-
- type: CMD
135-
value: '/usr/bin/identity-platform-admin-ui serve'
136-
description: >
137-
Launch Admin UI web server(s) using environment variables.
138-
debug:
139-
text: ""
85+
'`MAIL_FROM_ADDRESS`':
86+
type: env
87+
description: Email sender. Required.
88+
'`MAIL_HOST`':
89+
type: env
90+
description: SMPT server host. Required.
91+
'`MAIL_PORT`':
92+
type: env
93+
description: SMTP server port. Required.
94+
'`MAIL_USERNAME`':
95+
type: env
96+
description: SMTP username. If present, both username and password are used.
97+
'`MAIL_PASSWORD`':
98+
type: env
99+
description: SMTP password.
100+
'`OAUTH2_AUTH_COOKIES_ENCRYPTION_KEY`':
101+
type: env
102+
description: Key used to encrypt authentication cookies.
103+
'`OAUTH2_CLIENT_ID`':
104+
type: env
105+
description: OAuth2 client ID, needed for OIDC authentication.
106+
'`OAUTH2_CLIENT_SECRET`':
107+
type: env
108+
description: OAuth2 client secret, needed for OIDC authentication.
109+
'`OAUTH2_CODEGRANT_SCOPES`':
110+
type: env
111+
description: OAuth2 scopes needed by the application, needed for OIDC authentication.
112+
default: 'openid,offline_access'
113+
'`OAUTH2_REDIRECT_URI`':
114+
type: env
115+
description: OAuth2 redirect URI, e.g.'https://iam..io/dev/api/v0/auth/callback', where /api/v0/auth/callback is the endpoint used by the application, needed for OIDC authentication.
116+
'`OIDC_ISSUER`':
117+
type: env
118+
description: OAuth2 server issuer.
119+
'`OPENFGA_API_HOST`':
120+
type: env
121+
description: OpenFGA server address.
122+
'`OPENFGA_API_SCHEME`':
123+
type: env
124+
description: OpenFGA server scheme, either 'http' or 'https'.
125+
'`OPENFGA_API_TOKEN`':
126+
type: env
127+
description: OpenFGA server API token, needed for authentication to the server.
128+
'`OPENFGA_AUTHORIZATION_MODEL_ID`':
129+
type: env
130+
description: OpenFGA model ID.
131+
'`OPENFGA_STORE_ID`':
132+
type: env
133+
description: OpenFGA store ID.
134+
'`-p <port>:8080`':
135+
type: port
136+
description: Expose the container's port `8080` on the host's `<port>`.
137+
'`/usr/bin/identity-platform-admin-ui serve`':
138+
type: app
139+
description: Launch Admin UI web server(s) using environment variables.

0 commit comments

Comments
 (0)