.. _workbook-access:

===============
Access Workbook
===============

:Workbook name: tripleo.access.v1

TripleO administration access workflows

Workflows in the Access Workbook

.. object:: tripleo.access.v1.create_admin_via_nova

   Workflow inputs:

   :input tasks: Required.
   :input queue_name: Default: tripleo
   :input ssh_servers: Default: []
   :input overcloud_admin: Default: tripleo-admin
   :input ansible_extra_env_variables: Default: {'ANSIBLE_HOST_KEY_CHECKING': 'False'}

.. object:: tripleo.access.v1.create_admin_via_ssh

   Workflow inputs:

   :input tasks: Required.
   :input ssh_private_key: Required.
   :input ssh_user: Required.
   :input ssh_servers: Required.
   :input ansible_extra_env_variables: Default: {'ANSIBLE_HOST_KEY_CHECKING': 'False'}

.. object:: tripleo.access.v1.enable_ssh_admin

   This workflow creates an admin user on the overcloud nodes, which can then be used for connecting for automated administrative or deployment tasks, e.g. via Ansible. The workflow can be used both for Nova-managed and split-stack deployments, assuming the correct input values are passed in. The workflow defaults to Nova-managed approach, for which no additional parameters need to be supplied. In case of split-stack, temporary ssh connection details (user, key, list of servers) need to be provided -- these are only used temporarily to create the actual ssh admin user for use by Mistral.

   Workflow inputs:

   :input ssh_private_key: Default: None
   :input ssh_user: Default: None
   :input ssh_servers: Default: []
   :input overcloud_admin: Default: tripleo-admin
   :input queue_name: Default: tripleo
