osc-plugin Documentation

Transcription

1 osc-plugin Documentation Release OpenStack Foundation July 26, 2016

2

3 Contents 1 rdomanager-oscplugin Discovery Client Installation 5 3 Command List baremetal overcloud undercloud Indices and tables 13 i

4 ii

5 rdomanager-oscplugin is an OpenStackClient plugin. Contents: Contents 1

6 2 Contents

7 CHAPTER 1 rdomanager-oscplugin OpenStackClient reference plugin module The OSC plugin system is designed so that the plugin need only be properly installed for OSC to find and use it. It utilizes the setuptools entry points mechanism to advertise to OSC the plugin module and supported commands. rdomanager-oscplugin is an OpenStackClient (OSC) plugin implementation that implements commands useful for RDO manager and the install and management of both an undercloud and an overcloud. 1.1 Discovery OSC discovers extensions by enumerating the entry points found under openstack.cli.extension and initializing the given client module. [entry_points] openstack.cli.extension = oscplugin = oscplugin.plugin The client module must implement the following interface functions: API_NAME - A string containing the plugin API name; this is the name of the entry point declaring the plugin client module (oscplugin =... in the example above) and the group name for the plugin commands (openstack.oscplugin.v1 = in the example below) API_VERSION_OPTION (optional) - If set, the name of the API version attribute; this must be a valid Python identifier and match the destination set in build_option_parser(). API_VERSIONS - A dict mapping a version string to the client class build_option_parser(parser) - Hook to add global options to the parser make_client(instance) - Hook to create the client object OSC enumerates the loaded plugins and loads commands from the entry points defined for the API version: openstack.oscplugin.v1 = plugin_list = oscplugin.v1.plugin:listplugin plugin_show = oscplugin.v1.plugin:showplugin Note that OSC defines the group name as openstack.<api-name>.v<version> so the version should not contain the leading v character. This second step is identical to that performed for all but the Identity client in OSC itself. Identity is special due to the authentication requirements. This limits the ability to add additional auth modules to OSC. 3

8 1.2 Client The current implementation of the rdomanager_oscplugin Client class is an empty placeholder. This client object is not equired but OSC s ClientManager will maintain it as required and is the interface point for other plugins to access anything implemented by this plugin. 4 Chapter 1. rdomanager-oscplugin

9 CHAPTER 2 Installation At the command line: $ pip install rdomanager-oscplugin Or, if you have virtualenvwrapper installed: $ mkvirtualenv rdomanager-oscplugin $ pip install rdomanager-oscplugin 5

10 6 Chapter 2. Installation

11 CHAPTER 3 Command List 3.1 baremetal Baremetal v baremetal import Import baremetal nodes os baremetal import [ --service-host <service_host> ] [ --json --csv ] <file_in> --service-host <service_host> Nova compute service host to register nodes with (default None) --json Input file is in json format --csv Input file is in csv format <file_in> Filename to be imported baremetal introspection bulk start Begin introspection of all baremetal nodes os baremetal introspection bulk start baremetal introspection bulk status Get status of node introspection os baremetal introspection bulk status 7

12 3.1.4 baremetal configure boot Configure boot devices for all baremetal nodes os baremetal configure boot 3.2 overcloud Overcloud v overcloud deploy stack Deploy an overcloud stack openstack overcloud deploy stack (--plan PLAN --templates [TEMPLATES]) [-t <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--neutron-flat-networks NEUTRON_FLAT_NETWORKS] [--neutron-physical-bridge NEUTRON_PHYSICAL_BRIDGE] [--neutron-bridge-mappings NEUTRON_BRIDGE_MAPPINGS] [--neutron-public-interface NEUTRON_PUBLIC_INTERFACE] [--hypervisor-neutron-public-interface HYPERVISOR_NEUTRON_PUBLIC_INTERFACE] [--neutron-network-type NEUTRON_NETWORK_TYPE] [--neutron-tunnel-types NEUTRON_TUNNEL_TYPES] [--neutron-disable-tunneling] [--neutron-network-vlan-ranges NEUTRON_NETWORK_VLAN_RANGES] [--neutron-mechanism-drivers NEUTRON_MECHANISM_DRIVERS] [--libvirt-type LIBVIRT_TYPE] [--ntp-server NTP_SERVER] [--cinder-lvm] [--tripleo-root TRIPLEO_ROOT] [--nodes-json NODES_JSON] [--no-proxy NO_PROXY] [-O <OUTPUT DIR>] [-e <HEAT ENVIRONMENT FILE>] [--rhel-reg] [--reg-method {satellite,portal}] [--reg-org REG_ORG] [--reg-force] [--reg-sat-url REG_SAT_URL] [--reg-activation-key REG_ACTIVATION_KEY] --plan <name or UUID> The Name or UUID of the Tuskar plan to deploy. --templates <directory> The directory containing the Heat templates to deploy. -t <timeout>, --timeout <timeout> Deployment timeout in minutes (default: 240) 8 Chapter 3. Command List

13 --control-scale <scale-amount> New number of control nodes. --compute-scale <scale-amount> New number of compute nodes. --ceph-storage-scale <scale-amount> New number of ceph storage nodes. --block-storage-scale <scale-amount> New number of block storage nodes. --swift-storage-scale <scale-amount> New number of swift storage nodes. --control-flavor <flavor-name> Nova flavor to use for control nodes. --compute-flavor <flavor-name> Nova flavor to use for compute nodes. --ceph-storage-flavor <flavor-name> Nova flavor to use for ceph storage nodes. --block-storage-flavor <flavor-name> Nova flavor to use for cinder storage nodes. --swift-storage-flavor <flavor-name> Nova flavor to use for swift storage nodes. --neutron-flat-networks <networks> Comma separated list of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names. (default: datacentre ) --neutron-physical-bridge <bridge> Deprecated. --neutron-bridge-mappings <mappings> Comma separated list of bridge mappings. (default: datacentre:br-ex) --neutron-public-interface <interface> Deprecated. --hypervisor-neutron-public-interface <interface> Deprecated. --neutron-network-type <type> The network type for the tenant networks. --neutron-tunnel-types <type> Network types supported by the agent (gre and/or vxlan). --neutron-disable-tunneling Disables tunneling. --neutron-network-vlan-ranges <ranges> Comma separated list of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. (ex: datacentre:1:1000) --neutron-mechanism-drivers <drivers> An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace overcloud 9

14 --libvirt-type {kvm,qemu} Libvirt domain type. (default: kvm) --ntp-server <ip-address> The NTP for overcloud nodes. --cinder-lvm Enables the cinder lvm/iscsi backend. --tripleo-root <directory> The root directory for TripleO templates. --nodes-json <file> A file containing node definitions. (default: instackenv.json) --no-proxy <hosts> A comma separated list of hosts that should not be proxied. -O <directory>, --output-dir <directory> Directory to write Tuskar template files into. It will be created if it does not exist. If not provided a temporary directory will be used. -e <file>, --environment-file <file> Environment files to be passed to the heat stack-create or heat stack-update command. (Can be specified more than once.) --rhel-reg Register overcloud nodes to the customer portal or a satellite. --reg-method [sattelite portal] RHEL registration method to use for the overcloud nodes. --reg-org <organization> Organization key to use for registration. --reg-force Register the system even if it is already registered. --reg-sat-url <url> Satellite server to register overcloud nodes. --reg-activation-key <key> Activation key to use for registration. 3.3 undercloud Undercloud v undercloud install Install the undercloud os undercloud install If you would like to contribute to the development of OpenStack, you must follow the steps in the If you re a developer, start here section of this page: 10 Chapter 3. Command List

15 Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: undercloud 11

16 12 Chapter 3. Command List

17 CHAPTER 4 Indices and tables genindex modindex search 13

18 14 Chapter 4. Indices and tables

19 Index Symbols block-storage-flavor <flavor-name> block-storage-scale <scale-amount> ceph-storage-flavor <flavor-name> ceph-storage-scale <scale-amount> cinder-lvm compute-flavor <flavor-name> compute-scale <scale-amount> control-flavor <flavor-name> control-scale <scale-amount> csv baremetal-import command line option, 7 hypervisor-neutron-public-interface <interface> json baremetal-import command line option, 7 libvirt-type {kvm,qemu} neutron-bridge-mappings <mappings> neutron-disable-tunneling neutron-flat-networks <networks> neutron-mechanism-drivers <drivers> neutron-network-type <type> neutron-network-vlan-ranges <ranges> neutron-physical-bridge <bridge> neutron-public-interface <interface> neutron-tunnel-types <type> no-proxy <hosts> nodes-json <file> ntp-server <ip-address> plan <name or UUID> overcloud-deploy-stack command line option, 8 reg-activation-key <key> reg-force reg-method [sattelite portal] reg-org <organization> reg-sat-url <url> rhel-reg service-host <service_host> baremetal-import command line option, 7 swift-storage-flavor <flavor-name> swift-storage-scale <scale-amount> templates <directory> overcloud-deploy-stack command line option, 8 tripleo-root <directory> -O <directory>, output-dir <directory> -e <file>, environment-file <file> -t <timeout>, timeout <timeout> overcloud-deploy-stack command line option, 8 15

20 B baremetal-import command line option csv, 7 json, 7 service-host <service_host>, 7 O overcloud-deploy-stack command line option block-storage-flavor <flavor-name>, 9 block-storage-scale <scale-amount>, 9 ceph-storage-flavor <flavor-name>, 9 ceph-storage-scale <scale-amount>, 9 cinder-lvm, 10 compute-flavor <flavor-name>, 9 compute-scale <scale-amount>, 9 control-flavor <flavor-name>, 9 control-scale <scale-amount>, 9 hypervisor-neutron-public-interface <interface>, 9 libvirt-type {kvm,qemu}, 9 neutron-bridge-mappings <mappings>, 9 neutron-disable-tunneling, 9 neutron-flat-networks <networks>, 9 neutron-mechanism-drivers <drivers>, 9 neutron-network-type <type>, 9 neutron-network-vlan-ranges <ranges>, 9 neutron-physical-bridge <bridge>, 9 neutron-public-interface <interface>, 9 neutron-tunnel-types <type>, 9 no-proxy <hosts>, 10 nodes-json <file>, 10 ntp-server <ip-address>, 10 plan <name or UUID>, 8 reg-activation-key <key>, 10 reg-force, 10 reg-method [sattelite portal], 10 reg-org <organization>, 10 reg-sat-url <url>, 10 rhel-reg, 10 swift-storage-flavor <flavor-name>, 9 swift-storage-scale <scale-amount>, 9 templates <directory>, 8 tripleo-root <directory>, 10 -O <directory>, output-dir <directory>, 10 -e <file>, environment-file <file>, 10 -t <timeout>, timeout <timeout>, 8 16 Index