Skip to content

Commit

Permalink
feat: add admin-ui to oci-factory (#265)
Browse files Browse the repository at this point in the history
  • Loading branch information
shipperizer authored Oct 21, 2024
1 parent 31e1c67 commit f90b0df
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 0 deletions.
5 changes: 5 additions & 0 deletions oci/identity-platform-admin-ui/contacts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
notify:
emails:
- [email protected]
mattermost-channels:
- ofi4for9obfq8m978h318x56ar
139 changes: 139 additions & 0 deletions oci/identity-platform-admin-ui/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
version: 1
application: identity-platform-admin-ui
is_chiselled: True
description: |
Canonical IAM Admin UI is a component that allows you to interact with the components
that are part of the Identity Platform solution.
It provides a set of API to view,modify and delete resources on Ory Kratos, Ory Hydra
Ory Oathkeeper and OpenFGA
For further information check our repository on Github https://github.com/canonical/identity-platform-admin-ui
docker:
parameters:
- -p 8080:8080
access: Access the API at `http://localhost:8080`.
parameters:
- type: -e
value: 'TRACING_ENABLED=true'
description: Tracing enablement.
- type: -e
value: 'OTEL_GRPC_ENDPOINT=tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4317'
description: Tracing server GRPC endpoint, has priority on OTEL_HTTP_ENDPOINT.
- type: -e
value: 'OTEL_HTTP_ENDPOINT=http://tempo-0.tempo-endpoints.stg-identity-jaas-dev.svc.cluster.local:4318'
description: Tracing server HTTP endpoint.
- type: -e
value: 'MFA_ENABLED="true"'
description: Enable MFA validation on logins.
- type: -e
value: 'HYDRA_ADMIN_URL=http://hydra.io:4445'
description: Hydra Admin API URL, used to manage clients
- type: -e
value: 'KRATOS_ADMIN_URL=http://kratos.io:4434'
description: Kratos Admin API URL, used to manage identities
- type: -e
value: 'KRATOS_PUBLIC_URL=http://kratos.io:4433'
description: Kratos Public API URL, used to manage identities
- type: -e
value: 'OATHKEEPER_PUBLIC_URL=http://oathkeeper.io:4455'
description: Oathkeeper Public API URL, used to manage rules
- type: -e
value: 'BASE_URL=https://iam.io/dev/path'
description: Public URL Login UI will be served from.
- type: -e
value: 'ACCESS_TOKEN_VERIFICATION_STRATEGY=jwks'
description: Strategy used to verify JWT tokens.
- type: -e
value: 'AUTHENTICATION_ENABLED="true"'
description: Authentication enable flag.
- type: -e
value: 'AUTHORIZATION_ENABLED="true"'
description: Authorization enable flag.
- type: -e
value: 'CONTEXT_PATH=/dev/path'
description: Path needed by the UI to work behind an ingress proxy.
- type: -e
value: 'IDP_CONFIGMAP_NAME=providers'
description: Name of kubernetes configmap where Kratos IDP are configured.
- type: -e
value: 'IDP_CONFIGMAP_NAMESPACE=default'
description: Namespace of kubernetes configmap where Kratos IDP are configured.
- type: -e
value: 'RULES_CONFIGMAP_NAME=rules'
description: Name of kubernetes configmap where Oathkeeper rules are configured.
- type: -e
value: 'RULES_CONFIGMAP_NAMESPACE=default'
description: Namespace of kubernetes configmap where Oathkeeper rules are configured.
- type: -e
value: 'RULES_CONFIGMAP_FILENAME=rules.yaml'
description: Name of the file where Oathkeeper rules are configured.
- type: -e
value: 'SCHEMAS_CONFIGMAP_NAME=schemas'
description: Name of kubernetes configmap where Kratos identity schemas are configured.
- type: -e
value: 'SCHEMAS_CONFIGMAP_NAMESPACE=default'
description: Namespace of kubernetes configmap where Kratos identity schemas are configured.
- type: -e
value: '[email protected]'
description: Email sender
- type: -e
value: 'MAIL_HOST=smtp.io'
description: SMPT server host
- type: -e
value: 'MAIL_PASSWORD="***********************************"'
description: SMTP password
- type: -e
value: 'MAIL_PORT="1025"'
description: SMTP server port
- type: -e
value: 'MAIL_USERNAME="***********************************"'
description: SMTP password
- type: -e
value: 'OAUTH2_AUTH_COOKIES_ENCRYPTION_KEY="***********************************"'
description: Key used to encrypt authentication cookies
- type: -e
value: 'OAUTH2_CLIENT_ID=***********************************'
description: OAuth2 client ID, needed for OIDC authentication
- type: -e
value: 'OAUTH2_CLIENT_SECRET=***********************************'
description: OAuth2 client secret, needed for OIDC authentication
- type: -e
value: 'OAUTH2_CODEGRANT_SCOPES=openid,email,profile,offline_access'
description: OAuth2 scopes needed by the application, needed for OIDC authentication
- type: -e
value: 'OAUTH2_REDIRECT_URI=https://iam..io/dev/api/v0/auth/callback'
description: OAuth2 redirect uri where /api/v0/auth/callback is the endpoint used by the application, needed for OIDC authentication
- type: -e
value: 'OIDC_ISSUER=https://iam.dev.canonical.com/stg-identity-jaas-dev-hydra'
description: OAuth2 server issuer
- type: -e
value: 'OPENFGA_API_HOST=openfga:8443'
description: OpenFGA server address
- type: -e
value: 'OPENFGA_API_SCHEME=http'
description: OpenFGA server scheme
- type: -e
value: 'OPENFGA_API_TOKEN=***********************************'
description: OpenFGA server API token, needed for authentication to the server
- type: -e
value: 'OPENFGA_AUTHORIZATION_MODEL_ID=***********************************'
description: OpenFGA model ID
- type: -e
value: 'OPENFGA_STORE_ID=***********************************'
description: OpenFGA store ID
- type: -e
value: 'LOG_FILE=log.txt'
description: Destination file for logs.
- type: -e
value: 'LOG_LEVEL=error'
description: Log level.
- type: -p
value: '8080:8080'
description: Server API port.
- type: CMD
value: '/usr/bin/identity-platform-admin-ui serve'
description: >
Launch Admin UI web server(s) using environment variables.
debug:
text: ""
12 changes: 12 additions & 0 deletions oci/identity-platform-admin-ui/image.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 1
upload:
- source: "canonical/identity-platform-admin-ui"
commit: c46a9568f9be665f86aa5a274d8ac9d90054ba6b
directory: .
release:
1.19.0-22.04:
risks:
- stable
- candidate
- edge
end-of-life: "2025-03-01T00:00:00Z"

0 comments on commit f90b0df

Please sign in to comment.