OpenBao

Learn about actions >

• authorize-charm

  Authorizes the charm to be able to interact with OpenBao to manage its operations. A token is required for OpenBao to use to create the app role and the policy the charm will use to interact with OpenBao. This token must be placed in juju secret, and this secret should be granted to the charm.

  Params

  • secret-id string

    A secret id from juju that contains a token for OpenBao that can create new policies, such as the root token that is provided upon initializing OpenBao. Used to create the app role and policy for the charm. It is not stored by the charm.

  Required

  secret-id

• bootstrap-raft

  Bootstraps raft using a peers.json file. This action requires the application to first be scaled to a single unit. Bootstrapping can help recover when quorum is lost, however, it may cause uncommitted Raft log entries to be committed. See https://openbao.org/docs/concepts/integrated-storage#manual-recovery-using-peers-json for more details.

• create-backup

  Creates a snapshot of the Raft backend and saves it to the S3 storage. Returns backup ID.

  Params

  • skip-verify boolean

    Whether to skip the verification of the S3 connection TLS certificate. If set to "true", the charm will not verify the S3 connection.

• list-backups

  Lists all available backups.

  Params

  • skip-verify boolean

    Whether to skip the verification of the S3 connection TLS certificate. If set to "true", the charm will not verify the S3 connection.

• restore-backup

  Restores a backup from the S3 storage to the Raft backend. Returns backup ID.

  Params

  • backup-id string

    Backup ID to restore.

  • skip-verify boolean

    Whether to skip the verification of the S3 connection TLS certificate. If set to "true", the charm will not verify the S3 connection.

  Required

  backup-id