zuul/nodepool
Code Issues Proposed changes

Update docs for shell-type driver config

Browse Source 
Change-Id: I08aa454ed55992f444a602abc2d52777edb7daac
This commit is contained in:
Daniel Blixt 2021-03-08 22:39:32 +01:00 committed by James E. Blair
parent 6efac6cea2
commit 446c0ca7d2
8 changed files with 74 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/aws.rst
View File

@ -194,11 +194,15 @@ section of the configuration.
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g
``csh`` or ``fish``. For a windows image with the experimental - For a windows image with the experimental `connection-type` ``ssh``
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: pools .. attr:: pools
:type: list :type: list

14
doc/source/gce.rst
View File

@ -158,11 +158,15 @@ section of the configuration.
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g.
``csh`` or ``fish``. For a windows image with the experimental - For a windows image with the experimental `connection-type` ``ssh``
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: connection-type .. attr:: connection-type
:type: str :type: str

14
doc/source/kubernetes.rst
View File

@ -135,11 +135,15 @@ Selecting the kubernetes driver adds the following options to the
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g.
``csh`` or ``fish``. For a windows image with the experimental - For a windows pod with the experimental `connection-type`
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set ``ssh``, in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: cpu .. attr:: cpu
:type: int :type: int

14
doc/source/openshift-pods.rst
View File

@ -116,11 +116,15 @@ Selecting the openshift pods driver adds the following options to the
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g
``csh`` or ``fish``. For a windows node with the experimental - For a windows pod with the experimental `connection-type`
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set ``ssh``, in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: env .. attr:: env
:type: list :type: list

14
doc/source/openshift.rst
View File

@ -143,11 +143,15 @@ Selecting the openshift driver adds the following options to the
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g
``csh`` or ``fish``. For a windows image with the experimental - For a windows image with the experimental `connection-type`
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set ``ssh``, in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: cpu .. attr:: cpu
:type: int :type: int

14
doc/source/openstack.rst
View File

@ -352,11 +352,15 @@ Selecting the OpenStack driver adds the following options to the
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g
``csh`` or ``fish``. For a windows image with the experimental - For a windows image with the experimental `connection-type`
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set ``ssh``, in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: connection-type .. attr:: connection-type
:type: str :type: str

14
doc/source/static.rst
View File

@ -150,11 +150,15 @@ Selecting the static driver adds the following options to the
:default: sh :default: sh
The shell type of the node's default shell executable. Used by Zuul The shell type of the node's default shell executable. Used by Zuul
to set ``ansible_shell_type``. This setting should not be used to set ``ansible_shell_type``. This setting should only be used
unless the default shell is a non-Bourne (sh) compatible shell, e.g
``csh`` or ``fish``. For a windows node with the experimental - For a windows node with the experimental `connection-type`
`connection-type` ``ssh``, ``cmd`` or ``powershell`` should be set ``ssh``, in which case ``cmd`` or ``powershell`` should be set
and reflect the node's ``DefaultShell`` configuration. and reflect the node's ``DefaultShell`` configuration.
- If the default shell is not Bourne compatible (sh), but instead
e.g. ``csh`` or ``fish``, and the user is aware that there is a
long-standing issue with ``ansible_shell_type`` in combination
with ``become``
.. attr:: max-parallel-jobs .. attr:: max-parallel-jobs
:type: int :type: int

11
releasenotes/notes/shell-type-config-ee83971f4cdae0d9.yaml Normal file
View File

@ -0,0 +1,11 @@
---
features:
- |
AWS EC2, GCE, Kubernetes, Openshift, Openshift Pods, OpenStack and Static
drivers now support a shell-type config. Shell-type config is intended
to enable setting of cmd or powershell as shell type for Windows workers
with connection-type ssh.
For Linux workers, there is a long standing ansible issue with using
non-default shell type and become, so care should be taken if using
it for such workers.