Fix indentation for azure driver documentation
Change-Id: I29f03ace0689c6d5bf5a0fa8946aba073d06f7e6
This commit is contained in:
Albin Vass
parent
62f52878d2
commit
7ff91dd364
|
|
@ -86,132 +86,132 @@ section of the configuration.
|
|||
|
||||
Subnet to create VMs on
|
||||
|
||||
.. attr:: cloud-images
|
||||
:type: list
|
||||
|
||||
Each entry in this section must refer to an entry in the
|
||||
:attr:`labels` section.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
cloud-images:
|
||||
- name: bionic
|
||||
username: zuul
|
||||
image-reference:
|
||||
sku: 18.04-LTS
|
||||
publisher: Canonical
|
||||
version: latest
|
||||
offer: UbuntuServer
|
||||
- name: windows-server-2016
|
||||
username: zuul
|
||||
image-reference:
|
||||
sku: 2016-Datacenter
|
||||
publisher: MicrosoftWindowsServer
|
||||
version: latest
|
||||
offer: WindowsServer
|
||||
|
||||
|
||||
Each entry is a dictionary with the following keys
|
||||
|
||||
.. attr:: name
|
||||
:type: string
|
||||
:required:
|
||||
|
||||
Identifier to refer this cloud-image from :attr:`labels`
|
||||
section. Since this name appears elsewhere in the nodepool
|
||||
configuration file, you may want to use your own descriptive
|
||||
name here.
|
||||
|
||||
.. attr:: username
|
||||
:type: str
|
||||
|
||||
The username that a consumer should use when connecting to the
|
||||
node.
|
||||
|
||||
.. attr:: image-reference
|
||||
:type: dict
|
||||
:required:
|
||||
|
||||
.. attr:: sku
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image SKU
|
||||
|
||||
.. attr:: publisher
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image Publisher
|
||||
|
||||
.. attr:: offer
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image offers
|
||||
|
||||
.. attr:: version
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image version
|
||||
|
||||
|
||||
.. attr:: pools
|
||||
.. attr:: cloud-images
|
||||
:type: list
|
||||
|
||||
A pool defines a group of resources from an Azure provider. Each pool has a
|
||||
maximum number of nodes which can be launched from it, along with a number
|
||||
of cloud-related attributes used when launching nodes.
|
||||
Each entry in this section must refer to an entry in the
|
||||
:attr:`labels` section.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
cloud-images:
|
||||
- name: bionic
|
||||
username: zuul
|
||||
image-reference:
|
||||
sku: 18.04-LTS
|
||||
publisher: Canonical
|
||||
version: latest
|
||||
offer: UbuntuServer
|
||||
- name: windows-server-2016
|
||||
username: zuul
|
||||
image-reference:
|
||||
sku: 2016-Datacenter
|
||||
publisher: MicrosoftWindowsServer
|
||||
version: latest
|
||||
offer: WindowsServer
|
||||
|
||||
|
||||
Each entry is a dictionary with the following keys
|
||||
|
||||
.. attr:: name
|
||||
:type: string
|
||||
:required:
|
||||
|
||||
A unique name within the provider for this pool of resources.
|
||||
Identifier to refer this cloud-image from :attr:`labels`
|
||||
section. Since this name appears elsewhere in the nodepool
|
||||
configuration file, you may want to use your own descriptive
|
||||
name here.
|
||||
|
||||
.. attr:: labels
|
||||
:type: list
|
||||
.. attr:: username
|
||||
:type: str
|
||||
|
||||
Each entry in a pool's `labels` section indicates that the
|
||||
corresponding label is available for use in this pool. When creating
|
||||
nodes for a label, the flavor-related attributes in that label's
|
||||
section will be used.
|
||||
The username that a consumer should use when connecting to the
|
||||
node.
|
||||
|
||||
.. code-block:: yaml
|
||||
.. attr:: image-reference
|
||||
:type: dict
|
||||
:required:
|
||||
|
||||
labels:
|
||||
- name: bionic
|
||||
cloud-image: bionic
|
||||
hardware-profile:
|
||||
vm-size: Standard_D1_v2
|
||||
.. attr:: sku
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Each entry is a dictionary with the following keys
|
||||
Image SKU
|
||||
|
||||
.. attr:: name
|
||||
.. attr:: publisher
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image Publisher
|
||||
|
||||
.. attr:: offer
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image offers
|
||||
|
||||
.. attr:: version
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Image version
|
||||
|
||||
|
||||
.. attr:: pools
|
||||
:type: list
|
||||
|
||||
A pool defines a group of resources from an Azure provider. Each pool has a
|
||||
maximum number of nodes which can be launched from it, along with a number
|
||||
of cloud-related attributes used when launching nodes.
|
||||
|
||||
.. attr:: name
|
||||
:required:
|
||||
|
||||
A unique name within the provider for this pool of resources.
|
||||
|
||||
.. attr:: labels
|
||||
:type: list
|
||||
|
||||
Each entry in a pool's `labels` section indicates that the
|
||||
corresponding label is available for use in this pool. When creating
|
||||
nodes for a label, the flavor-related attributes in that label's
|
||||
section will be used.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
labels:
|
||||
- name: bionic
|
||||
cloud-image: bionic
|
||||
hardware-profile:
|
||||
vm-size: Standard_D1_v2
|
||||
|
||||
Each entry is a dictionary with the following keys
|
||||
|
||||
.. attr:: name
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Identifier to refer this label.
|
||||
|
||||
.. attr:: cloud-image
|
||||
:type: str
|
||||
:required:
|
||||
|
||||
Identifier to refer this label.
|
||||
Refers to the name of an externally managed image in the
|
||||
cloud that already exists on the provider. The value of
|
||||
``cloud-image`` should match the ``name`` of a previously
|
||||
configured entry from the ``cloud-images`` section of the
|
||||
provider.
|
||||
|
||||
.. attr:: cloud-image
|
||||
:type: str
|
||||
:required:
|
||||
.. attr:: hardware-profile
|
||||
:required:
|
||||
|
||||
Refers to the name of an externally managed image in the
|
||||
cloud that already exists on the provider. The value of
|
||||
``cloud-image`` should match the ``name`` of a previously
|
||||
configured entry from the ``cloud-images`` section of the
|
||||
provider.
|
||||
.. attr:: vm-size
|
||||
:required:
|
||||
:type: str
|
||||
|
||||
.. attr:: hardware-profile
|
||||
:required:
|
||||
|
||||
.. attr:: vm-size
|
||||
:required:
|
||||
:type: str
|
||||
|
||||
VM Size of the VMs to use in Azure. See the VM size list on `azure.microsoft.com`_
|
||||
for the list of sizes availabile in each region.
|
||||
VM Size of the VMs to use in Azure. See the VM size list on `azure.microsoft.com`_
|
||||
for the list of sizes availabile in each region.
|
||||
|
||||
|
||||
.. _`Azure CLI`: https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli?view=azure-cli-latest
|
||||
|
|
|
|||
Loading…
Reference in New Issue