acme.runtime.Onboarding

module documentation

Interactively create a new basic configuration file.

Function buildUserConfigFile Build a new user configuration file interactively. If the zookeeper host, port, and root path are provided, the configuration will be stored in the ZooKeeper service instead of a local file.
Variable configParser Undocumented
Variable console The console to use for printing messages.
Variable currentStep Undocumented
Variable progressBar Undocumented
Variable totalSteps Undocumented
Function _containsVariable Check if the value contains an interpolation variable.
Function _print Print a message to the console.
Function _printHeader Print a header with the given title.
Function _printRule Undocumented
Function _setOption Undocumented
Variable _iniValues Default values for the configuration file.
Variable _interpolationVariable Regular expression to match interpolation variables.
def buildUserConfigFile(configFile: str | None, zkConfiguration: tuple[str, int, str | None] | None = None, overwrite: bool = False) -> tuple[bool, str | None, str | None]:

Build a new user configuration file interactively. If the zookeeper host, port, and root path are provided, the configuration will be stored in the ZooKeeper service instead of a local file.

Parameters
configFile:str | NoneThe configuration file to create.
zkConfiguration:tuple[str, int, str | None] | NoneA tuple containing the ZooKeeper host, port, and root path.
overwrite:boolIf True, overwrite the configuration or configuration file if it already exists.
Returns
A tuple with three elements
  • True if the configuration was created, False otherwise.
  • The configuration file name if created, None otherwise.
  • The error message if the configuration file could not be created, None otherwise.
configParser =

Undocumented

console =

The console to use for printing messages.

currentStep: int =

Undocumented

progressBar =

Undocumented

totalSteps: int =

Undocumented

def _containsVariable(value: str) -> bool:

Check if the value contains an interpolation variable.

Parameters
value:strThe value to check.
Returns
boolTrue if the value contains an interpolation variable, False otherwise.
def _print(msg: str | Rule | Syntax = '\n', clearScreen: bool | None = True):

Print a message to the console.

Parameters
msg:str | Rule | SyntaxThe message to print. Could be a string, a Rule, or a Syntax object.
clearScreen:bool | NoneIf True, clear the console before printing the message.
def _printHeader(title: str):

Print a header with the given title.

Parameters
title:strThe title to print.
def _printRule(title: str, extras: str | None = None):

Undocumented

def _setOption(config: ACMEConfiguration.ACMEConfiguration, section: str, option: str, value: str, toLower: bool | None = False) -> str:

Undocumented

_iniValues: dict[str, dict] =

Default values for the configuration file.

_interpolationVariable =

Regular expression to match interpolation variables.