---
title: Charmhub | Deploy Valkey using Charmhub - The Open Operator Collection
description: Deploy the latest version of Valkey as a Kubernetes Operator on any cloud.
url: https://charmhub.io/valkey/configurations
---

# Valkey

[Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

* [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

Platform:

9/stable 148

```
juju deploy valkey --channel 9/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [aof-appendfsync](https://charmhub.io/valkey/configurations#aof-appendfsync)
* [certificate-extra-sans](https://charmhub.io/valkey/configurations#certificate-extra-sans)
* [ldap-map](https://charmhub.io/valkey/configurations#ldap-map)
* [ldap-query-template](https://charmhub.io/valkey/configurations#ldap-query-template)
* [ldap-search-attribute](https://charmhub.io/valkey/configurations#ldap-search-attribute)
* [ldap-search-dn-attribute](https://charmhub.io/valkey/configurations#ldap-search-dn-attribute)
* [ldap-search-filter](https://charmhub.io/valkey/configurations#ldap-search-filter)
* [pause-after-unit-refresh](https://charmhub.io/valkey/configurations#pause-after-unit-refresh)
* [persistence-mode](https://charmhub.io/valkey/configurations#persistence-mode)
* [rdb-save-points](https://charmhub.io/valkey/configurations#rdb-save-points)
* [system-users](https://charmhub.io/valkey/configurations#system-users)
* [tls-client-private-key](https://charmhub.io/valkey/configurations#tls-client-private-key)

[Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration)

* aof-appendfsync | string

  Default: everysec

  When to fsync the append-only file to disk. "no": the operating system decides.
  "everysec": once per second. "always": after every write. Only used when
  persistence-mode is "AOF" or "RDB+AOF".
* certificate-extra-sans | string

  Config option to add extra-sans to the ones used when requesting server certificates.
  The extra-sans are specified by comma-separated names to be added when requesting signed certificates.
  Use "{unit}" as a placeholder to be filled with the unit number, e.g. "worker-{unit}" will be translated as
  "worker-0" for unit 0 and "worker-1" for unit 1 when requesting the certificate.
* ldap-map | string

  Config option for LDAP integration, to configure the mapping of LDAP group names to
  pre-configured Valkey authorization groups. The authorization groups are defined via extra
  entity permissions through Data integrator.
  Comma-separated list, for example: <ldap\_group\_1>=<valkey\_read>,<ldap\_group\_2>=<valkey\_write>
* ldap-query-template | string

  Default: (&(objectClass=posixAccount)(memberOf=cn={group},\*))

  Config option for LDAP integration, to configure the search filter the charm uses to list
  the members of an LDAP group named in `ldap-map`. The placeholder `{group}` is replaced with
  the LDAP group name. The default addresses groups by their `cn` RDN, as the Authentik LDAP
  outpost does. For directories where groups are organizational units, such as GLAuth, use
  "(&(objectClass=posixAccount)(memberOf=ou={group},\*))". This filter is independent of
  `ldap-search-filter`, which Valkey itself uses to look up a single user at login.
* ldap-search-attribute | string

  Default: cn

  Config option for LDAP integration, to configure the entry attribute of the LDAP provider
  when searching for a username. Corresponds to Valkey config `ldap.search_attribute`.
* ldap-search-dn-attribute | string

  Default: DN

  Config option for LDAP integration, to configure the attribute that contains the DN of the
  user entry. Corresponds to Valkey config `ldap.search_dn_attribute`. If the LDAP provider
  does not return a DN attribute, ensure LDAP users have an email attribute and use `mail`
  instead.
* ldap-search-filter | string

  Default: objectClass=posixAccount

  Config option for LDAP integration, to configure the search filter used to filter LDAP
  directory entries. Corresponds to Valkey config `ldap.search_filter`.
* pause-after-unit-refresh | string

  Default: first

  Wait for manual confirmation to resume refresh after these units refresh
  Allowed values: "all", "first", "none"
* persistence-mode | string

  Default: RDB

  Configure the persistence mode of Valkey. Allowed values are "RDB", "AOF", "RDB+AOF"
  and "None". An invalid value is ignored: the charm keeps the last valid settings and
  sets a blocked status.
* rdb-save-points | string

  Default: 900 1 300 100 60 10000

  When to save a point-in-time snapshot (RDB file) of the dataset, as pairs of
  "<seconds> <changes>". Valkey saves once that many seconds have passed and at least that
  many writes happened since the last save. The default saves every 900 seconds after at
  least 1 write, every 300 seconds after at least 100 writes and every 60 seconds after at
  least 10000 writes. Only used when persistence-mode is "RDB" or "RDB+AOF".
* system-users | secret

  Configure the internal system users and their passwords. The passwords will
  be auto-generated if this option is not set. It is for internal use only
  and SHOULD NOT be used by applications. This needs to be a Juju Secret URI pointing
  to a secret that contains the following content: `username: <password>`.
  The following system users are supported:

  + charmed-operator: administrative user for the charmed valkey operator
  + charmed-replication: used by valkey replica instances to connect to the primary
  + charmed-stats: used by the metrics exporter to connect to valkey
  + charmed-sentinel-operator: administrative user for operating valkey sentinel
  + charmed-sentinel-valkey: used by sentinel to authenticate against valkey
  + charmed-sentinel-peers: used by sentinel for inter-sentinel authentication
* tls-client-private-key | secret

  A Juju secret URI of a secret containing the private key for client TLS certificates.
