Lucky Client

Interact with Juju, Lucky, and Docker in charm scripts.

Usage

client [FLAGS] <SUBCOMMAND>

Options

ArgEnvironment VariableDescription
-u, --unit-name<unit_name>JUJU_UNIT_NAMEThe name of the Juju unit that this charm is running for. This is not required if socket-path has been specified.
-s, --socket-path<socket_path>LUCKY_DAEMON_SOCKETThe path to the daemon socket. If this is left unspecified the socket path will be automatically determined from the unit name. For example, for a unit named mysql/2, the socket path will be /run/lucky_mysql_2.sock

Subcommands

  • set-status: Set the status of the current script
  • kv: Get and set values in the unit key-value store
  • container: Manipulate the charm's container(s)
  • public-address: Get the public address of the unit
  • private-address: Get the private IP address of the unit
  • get-config: Get the charm configuration
  • port: Open and close ports on the firewall
  • relation: Communicate over Juju relations
  • leader: Communicate as/with unit leader
  • random: Generate random numbers and strings
  • get-resource: Get the path to a Juju resource

Getting Started

The lucky client command contains every command that your charm scripts can use to interact with Juju, Lucky, and Docker.

It is important to realize that this command is only used in charm scipts and as help reference for the charm developer. Also, when using this command in charm scripts, you leave out the client portion of the command and just use lucky. For example, if you locally use lucky client set-status --help to find out what options the set-status command has, when you use it in your charm scripts, you just put lucky set-status, without the client.