Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions charts/ad2image/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: ad2image
description: "easy avatars powered by AD / Exchange & Identicons"
type: application
version: 2.0.1
appVersion: "1.2.0"
version: 2.1.0
appVersion: "2.0.0"
maintainers:
- name: eidottermihi
email: eidottermihi@gmail.com
Expand Down
86 changes: 48 additions & 38 deletions charts/ad2image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,47 +16,57 @@ The command deploys ad2image on the Kubernetes cluster with some default configu

## Configuration

| Key | Type | Default | Description |
| -------------------------- | ------ | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| image.imagePullSecrets | list | `[]` | Image pull secrets specification |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
| image.repository | string | `"ghcr.io/it-at-m/ad2image"` | Image to use for deploying |
| image.tag | string | `""` | Image tag |
| ingress.extraLabels | object | `{}` | Extra labels for the ingress |
| ingress.annotations | object | `{}` | Annotations to add to the Ingress resource. |
| ingress.className | string | `""` | IngressClass name to use (e.g., `nginx`). |
| ingress.enabled | bool | `false` | Enable Kubernetes Ingress. |
| ingress.hosts | list | `[]` | List of host rules (each with `host` and `paths`). |
| ingress.tls | list | `[]` | TLS settings for the Ingress (e.g., hosts and secretName). |
| nameOverride | string | `""` | Override chart name |
| podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context |
| service.annotations | object | `{}` | Service annotations |
| service.port | int | `3000` | Service port |
| service.type | string | `"ClusterIP"` | Service type |
| serviceAccount.annotations | object | `{}` | Service account annotations |
| serviceAccount.create | bool | `true` | Create service account |
| serviceAccount.name | string | `""` | Service account name |
| defaultMode | string | `""` | To overwrite the default mode. |
| ad.url | string | `""` | Connection URL for the AD server, for example `ldaps://ad.mydomain.com:636`. |
| ad.userSearchBase | string | `""` | User search base for user lookup, for example `OU=Users,DC=mycompany,DC=com`. |
| ad.userSearchFilter | string | `"(&(objectClass=organizationalPerson)(cn={uid}))"` | User search filter; `{uid}` is replaced with the requested user UID. |
| ews.ewsServiceUrl | string | `""` | EWS service URL, e.g. <https://computer.domain.contoso.com/EWS/Exchange.asmx>. |
| ews.domain | string | `""` | Exchange/EWS domain, e.g. 'domain.contoso.com' |
| docsUrl | string | `""` | Used as redirect URL for /. |
| credentials.existingSecret | string | `""` | set a secret name here if you want to manage secrets on your own. required keys: [AD_USER_DN, AD_PASSWORD, EWS_USERNAME, EWS_PASSWORD] |
| credentials.adUserDn | string | `""` | Bind User-DN for AD authentication |
| credentials.adPassword | string | `""` | Password for AD authentication |
| credentials.ewsUsername | string | `""` | Username for EWS NTLM authentication. |
| credentials.ewsPassword | string | `""` | Password for EWS NTLM authentication. |
| cache.existingConfigMap | string | `""` | Existing ConfigMap with key 'ehcache.xml' containing a custom EhCache configuration |
| extraEnvVars | list | `[]` | Extra environment variables |
| extraVolumes | list | `[]` | Extra volumes |
| extraVolumeMounts | list | `[]` | Extra volumeMounts for the pods |
| initContainers | list | `[]` | Extra initContainers for the pods |
| routes | object | `{}` | OpenShift Route definitions (see default `values.yaml` for examples) |
| Key | Type | Default | Description |
| ----------------------------- | ------ | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| image.imagePullSecrets | list | `[]` | Image pull secrets specification |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
| image.repository | string | `"ghcr.io/it-at-m/ad2image"` | Image to use for deploying |
| image.tag | string | `""` | Image tag |
| ingress.extraLabels | object | `{}` | Extra labels for the ingress |
| ingress.annotations | object | `{}` | Annotations to add to the Ingress resource. |
| ingress.className | string | `""` | IngressClass name to use (e.g., `nginx`). |
| ingress.enabled | bool | `false` | Enable Kubernetes Ingress. |
| ingress.hosts | list | `[]` | List of host rules (each with `host` and `paths`). |
| ingress.tls | list | `[]` | TLS settings for the Ingress (e.g., hosts and secretName). |
| nameOverride | string | `""` | Override chart name |
| podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context |
| service.annotations | object | `{}` | Service annotations |
| service.port | int | `3000` | Service port |
| service.type | string | `"ClusterIP"` | Service type |
| serviceAccount.annotations | object | `{}` | Service account annotations |
| serviceAccount.create | bool | `true` | Create service account |
| serviceAccount.name | string | `""` | Service account name |
| defaultMode | string | `""` | To overwrite the default mode. |
| ad.url | string | `""` | Connection URL for the AD server, for example `ldaps://ad.mydomain.com:636`. |
| ad.userSearchBase | string | `""` | User search base for user lookup, for example `OU=Users,DC=mycompany,DC=com`. |
| ad.userSearchFilter | string | `"(&(objectClass=organizationalPerson)(cn={uid}))"` | User search filter; `{uid}` is replaced with the requested user UID. |
| ews.ewsServiceUrl | string | `""` | EWS service URL, e.g. <https://computer.domain.contoso.com/EWS/Exchange.asmx>. |
| gravatar.enabled | bool | `false` | Enables/disables the gravatar compatability endpoint. |
| gravatar.hashCacheRefreshCron | string | `"0 0 4 * * *"` | cron expression for periodic refresh of the SHA256 email address hashes, "-" to disable. |
| gravatar.mapPopulationFilter | string | `"(&(objectClass=organizationalPerson)(mail=*))"` | LDAP search filter for users which should be included in generation of SHA256-hashed email addresses |
| gravatar.pageSize | int | `500` | page size for retrieval of users |
| docsUrl | string | `""` | Used as redirect URL for /. |
| credentials.existingSecret | string | `""` | set a secret name here if you want to manage secrets on your own. required keys: [AD_USER_DN, AD_PASSWORD, EWS_USERNAME, EWS_PASSWORD] |
| credentials.adUserDn | string | `""` | Bind User-DN for AD authentication |
| credentials.adPassword | string | `""` | Password for AD authentication |
| credentials.ewsUsername | string | `""` | Username for EWS NTLM authentication. |
| credentials.ewsPassword | string | `""` | Password for EWS NTLM authentication. |
| cache.existingConfigMap | string | `""` | Existing ConfigMap with key 'ehcache.xml' containing a custom EhCache configuration |
| extraEnvVars | list | `[]` | Extra environment variables |
| extraVolumes | list | `[]` | Extra volumes |
| extraVolumeMounts | list | `[]` | Extra volumeMounts for the pods |
| initContainers | list | `[]` | Extra initContainers for the pods |
| routes | object | `{}` | OpenShift Route definitions (see default `values.yaml` for examples) |

## Changelog

### 2.1.0

#### appVersion 2.0.0

- `ews.domain` value removed as it was only needed for NTLM authentication and is no longer relevant for Basic Authentication used in 2.0.0.
- `gravatar.***` compatibility endpoint configuration options added

### 2.0.0

#### Route definition
Expand Down
3 changes: 2 additions & 1 deletion charts/ad2image/ci/test-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ ad:
userSearchFilter: "(&(objectClass=organizationalPerson)(cn={uid}))"
ews:
ewsServiceUrl: "https://ews.mydomain.test/EWS/Exchange.asmx"
domain: "ews.mydomain.test"
gravatar:
enabled: true
credentials:
adUserDn: "DN=test.user,OU=Users,DC=mycompany,DC=test"
adPassword: "testTest"
Expand Down
8 changes: 6 additions & 2 deletions charts/ad2image/templates/configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ data:
user-search-filter: {{ required "AD user-search-filter must be provided" .ad.userSearchFilter | quote }}
ews:
ews-service-url: {{ required "EWS service url must be provided" .ews.ewsServiceUrl | quote }}
domain: {{ required "EWS domain must be provided" .ews.domain | quote }}
web.docs.url: {{ .docsUrl | default "https://github.com/it-at-m/ad2image" | quote }}
gravatar:
enabled: {{ .gravatar.enabled | quote }}
hash-cache-refresh-cron: {{ .gravatar.hashCacheRefreshCron | quote }}
map-population-filter: {{ .gravatar.mapPopulationFilter | quote }}
page-size: {{ .gravatar.pageSize | quote }}
web.docs.url: {{ .docsUrl | default "/swagger-ui/index.html" | quote }}

logging:
level:
Expand Down
Loading
Loading