starlingx/docs
Code Issues Proposed changes

Migrate ks-addon.cfg example for update-iso.sh to Debian (r8, dsr8)

Browse Source 
- Resolved merge conflict.
- Removed lines from original ks-addon.cfg.
- Updated the ks-addon.cfg file example for installing-a-subcloud-without-redfish file.
- Updated the ks-addon.cfg file example for installation-prereqs file.

Change-Id: I98114f0742a89dcb2daa2a11efa9af3b43876143
Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
This commit is contained in:
Elaine Fonaro
2023-06-20 18:01:16 +00:00
parent a253678a1f
commit 968d63b8d7
2 changed files with 182 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst
View File

@@ -118,28 +118,32 @@ subcloud, the subcloud installation process has two phases:
The following example ``ks-addon.cfg`` file, used with the -a option, The following example ``ks-addon.cfg`` file, used with the -a option,
sets up an initial IP interface at boot time by defining a |VLAN| on sets up an initial IP interface at boot time by defining a |VLAN| on an
an Ethernet interface and has it use |DHCP| to request an IP address: Ethernet interface and has it use |DHCP| to request an IP address:
.. code-block:: none .. code-block:: none
#### start ks-addon.cfg #### start ks-addon.cfg
OAM_DEV=enp0s3 RAW_DEV=enp24s0f0
OAM_VLAN=1234 OAM_VLAN=103
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/ifcfg-${RAW_DEV}
DEVICE=$OAM_DEV iface ${RAW_DEV} inet manual
BOOTPROTO=none mtu 9000
ONBOOT=yes post-up echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/autoconf;\
LINKDELAY=20 echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/accept_ra;\
echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/accept_redirects
EOF EOF
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV.$OAM_VLAN cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/ifcfg-vlan${OAM_VLAN}
DEVICE=$OAM_DEV.$OAM_VLAN iface vlan${OAM_VLAN} inet6 dhcp
BOOTPROTO=dhcp vlan-raw-device ${RAW_DEV}
ONBOOT=yes mtu 1500
VLAN=yes post-up /usr/sbin/ip link set dev vlan${OAM_VLAN} mtu 1500;\
LINKDELAY=20 echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/autoconf;\
echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/accept_ra;\
echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/accept_redirects
pre-up /sbin/modprobe -q 8021q
EOF EOF
#### end ks-addon.cfg #### end ks-addon.cfg

299
doc/source/shared/_includes/installation-prereqs.rest
View File

@@ -1,136 +1,163 @@
.. _installation-prereqs: .. _installation-prereqs:
========================== ==========================
Installation Prerequisites Installation Prerequisites
========================== ==========================
.. begin-install-prereqs .. begin-install-prereqs
Several pre-requisites must be completed prior to starting the |prod| Several pre-requisites must be completed prior to starting the |prod|
installation. installation.
Before attempting to install |prod|, ensure that you have the following: Before attempting to install |prod|, ensure that you have the following:
.. _installation-pre-requisites-ul-uzl-rny-q3b: .. _installation-pre-requisites-ul-uzl-rny-q3b:
- The |prod-long| host installer ISO image file. - The |prod-long| host installer ISO image file.
- The ``update-iso.sh`` script. - The ``update-iso.sh`` script.
.. include:: /_includes/installation-prereqs.rest .. include:: /_includes/installation-prereqs.rest
:start-after: begin-vdr-additional-prereqs :start-after: begin-vdr-additional-prereqs
:end-before: end-vdr-additional-prereqs :end-before: end-vdr-additional-prereqs
- *Optionally*, if required, update the ISO image to modify installation boot - *Optionally*, if required, update the ISO image to modify installation boot
parameters, automatically select boot menu options and/or add a kickstart parameters, automatically select boot menu options and/or add a kickstart
file to automatically perform configurations such as configuring the initial file to automatically perform configurations such as configuring the initial
IP Interface for bootstrapping. IP Interface for bootstrapping.
Use the ``update-iso.sh`` script from |dnload-loc|. The script syntax and Use the ``update-iso.sh`` script from |dnload-loc|. The script syntax and
options are: options are:
.. code-block:: .. code-block::
update-iso.sh --initial-password <password> -i <input bootimage.iso> -o <output bootimage.iso> update-iso.sh -i <input bootimage.iso> -o <output bootimage.iso>
[ -a <ks-addon.cfg> ] [ -p param=value ] [ -a <ks-addon.cfg> ] [ -p param=value ]
[ -d <default menu option> ] [ -t <menu timeout> ] [ -d <default menu option> ] [ -t <menu timeout> ]
-i <file>: Specify input ISO file -i <file>: Specify input ISO file
-o <file>: Specify output ISO file -o <file>: Specify output ISO file
-a <file>: Specify ks-addon.cfg file -a <file>: Specify ks-addon.cfg file
--initial-password <password>: Specify the initial login password for sysadmin user -p <p=v>: Specify boot parameter
-p <p=v>: Specify boot parameter
Example:
Example: -p instdev=/dev/disk/by-path/pci-0000:00:0d.0-ata-1.0
-p instdev=/dev/disk/by-path/pci-0000:00:0d.0-ata-1.0
-d <default menu option>:
-d <default menu option>: Specify default boot menu option:
Specify default boot menu option: 0 - Standard Controller, Serial Console
0 - Standard Controller, Serial Console 1 - Standard Controller, Graphical Console
1 - Standard Controller, Graphical Console 2 - AIO, Serial Console
2 - AIO, Serial Console 3 - AIO, Graphical Console
3 - AIO, Graphical Console 4 - AIO Low-latency, Serial Console
4 - AIO Low-latency, Serial Console 5 - AIO Low-latency, Graphical Console
5 - AIO Low-latency, Graphical Console NULL - Clear default selection
NULL - Clear default selection -t <menu timeout>:
-t <menu timeout>: Specify boot menu timeout, in seconds
Specify boot menu timeout, in seconds
The following example ``ks-addon.cfg`` file, used with the ``-a`` option,
The following example ``ks-addon.cfg`` file, used with the ``-a`` option, sets up sets up an initial IP interface at boot time by defining a |VLAN| on an Ethernet
an initial IP interface at boot time by defining a VLAN on an Ethernet interface with with ``static`` assigned |VLAN| addresses:
interface and has it use DHCP to request an IP address:
.. code-block::
.. code-block::
#### start ks-addon.cfg
#### start ks-addon.cfg RAW_DEV=enp24s0f0
OAM_DEV=enp0s3 OAM_VLAN=103
OAM_VLAN=1234 MGMT_VLAN=163
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/auto
DEVICE=$OAM_DEV auto ${RAW_DEV} lo vlan${OAM_VLAN} vlan${MGMT_VLAN}
BOOTPROTO=none
ONBOOT=yes EOF
LINKDELAY=20
EOF cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/ifcfg-${RAW_DEV}
iface ${RAW_DEV} inet manual
cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV.$OAM_VLAN mtu 9000
DEVICE=$OAM_DEV.$OAM_VLAN post-up echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/autoconf;\
BOOTPROTO=dhcp echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/accept_ra;\
ONBOOT=yes echo 0 > /proc/sys/net/ipv6/conf/${RAW_DEV}/accept_redirects
VLAN=yes EOF
LINKDELAY=20
EOF cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/ifcfg-vlan${OAM_VLAN}
#### end ks-addon.cfg iface vlan${OAM_VLAN} inet6 static
vlan-raw-device ${RAW_DEV}
After updating the ISO image, create a bootable USB with the ISO or put the address <__address__>
ISO on a PXEBOOT server. See the next bullet for details. netmask 64
gateway <__address__>
- A mechanism for boot installation of the |prod-long| host installer ISO mtu 1500
downloaded from |dnload-loc|. This can be either: post-up /usr/sbin/ip link set dev vlan${OAM_VLAN} mtu 1500;\
echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/autoconf;\
- a bootable USB drive with the |prod-long| host installer ISO. echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/accept_ra;\
echo 0 > /proc/sys/net/ipv6/conf/vlan${OAM_VLAN}/accept_redirects
Refer to :ref:`bootable_usb` for instructions on how to create a pre-up /sbin/modprobe -q 8021q
bootable USB with the StarlingX ISO on your system. EOF
- the ISO image on a |PXE| boot server on the same network as the server cat << EOF > ${IMAGE_ROOTFS}/etc/network/interfaces.d/ifcfg-vlan${MGMT_VLAN}
that will be used as the initial controller-0. See Appendix iface vlan${MGMT_VLAN} inet6 static
:ref:`pxe-boot-controller-0-d5da025c2524` for details. vlan-raw-device ${RAW_DEV}
address <__address__>
netmask 64
- For all controller or AIO controller servers, |OAM| Network connectivity to: mtu 1500
post-up /usr/local/bin/tc_setup.sh vlan${MGMT_VLAN} mgmt 10000 > /dev/null;\
- the |BMC| ports of all nodes /usr/sbin/ip link set dev vlan${MGMT_VLAN} mtu 1500;\
echo 0 > /proc/sys/net/ipv6/conf/vlan${MGMT_VLAN}/autoconf;\
- An external DNS Server. This is required for accessing |org| Docker echo 0 > /proc/sys/net/ipv6/conf/vlan${MGMT_VLAN}/accept_ra;\
Registry as discussed below. echo 0 > /proc/sys/net/ipv6/conf/vlan${MGMT_VLAN}/accept_redirects
pre-up /sbin/modprobe -q 8021q
- A Docker Registry(s) containing the Docker images for the |prod| load EOF
accessible via the |OAM| Network.
#### end ks-addon.cfg
You can use one of the following options:
After updating the ISO image, create a bootable USB with the ISO or put the
.. only:: partner ISO on a PXEBOOT server. See the next bullet for details.
- The |org| Docker Registry. This is the default option. - A mechanism for boot installation of the |prod-long| host installer ISO
downloaded from |dnload-loc|. This can be either:
.. only:: starlingx
- a bootable USB drive with the |prod-long| host installer ISO.
- The public open source registries (i.e. docker.io, k8s.gcr.io,
ghcr.io, gcr.io, quay.io). This is the default option. Refer to :ref:`bootable_usb` for instructions on how to create a
bootable USB with the StarlingX ISO on your system.
- A private Docker Registry populated with the docker images from the
|reg-string|. - the ISO image on a |PXE| boot server on the same network as the server
that will be used as the initial controller-0. See Appendix
.. only:: partner :ref:`pxe-boot-controller-0-d5da025c2524` for details.
.. include:: /_includes/bootstrapping-from-a-private-docker-registry.rest
- For all controller or AIO controller servers, |OAM| Network connectivity to:
- A record of the IP addresses allocated for the public interfaces for your - the |BMC| ports of all nodes
deployment (that is IP addresses for the |OAM| Network and |SRIOV| Data
Networks). - An external DNS Server. This is required for accessing |org| Docker
Registry as discussed below.
.. end-install-prereqs - A Docker Registry(s) containing the Docker images for the |prod| load
accessible via the |OAM| Network.
You can use one of the following options:
.. only:: partner
- The |org| Docker Registry. This is the default option.
.. only:: starlingx
- The public open source registries (i.e. docker.io, k8s.gcr.io,
ghcr.io, gcr.io, quay.io). This is the default option.
- A private Docker Registry populated with the docker images from the
|reg-string|.
.. only:: partner
.. include:: /_includes/bootstrapping-from-a-private-docker-registry.rest
- A record of the IP addresses allocated for the public interfaces for your
deployment (that is IP addresses for the |OAM| Network and |SRIOV| Data
Networks).
.. end-install-prereqs