starlingx/docs
Code Issues Proposed changes

Merge "Refactoring changes"

Browse Source
This commit is contained in:
Zuul 2021-03-19 18:39:18 +00:00 committed by Gerrit Code Review
commit 9f6e23ac2f
3 changed files with 37 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/planning/kubernetes/starlingx-hardware-requirements.rst
View File

@ -80,13 +80,14 @@ Controller, worker, and storage hosts
| BIOS Mode | BIOS or UEFI | | BIOS Mode | BIOS or UEFI |
| | | | | |
| | .. note:: | | | .. note:: |
| | UEFI Secure Boot and UEFI PXE boot over IPv6 are not supported. On systems with an IPv6 management network, you can use a separate IPv4 network for PXE boot. For more information, see :ref:`PXE Boot Network <network-planning-the-pxe-boot-network>`. | | | UEFI Secure Boot and UEFI PXE boot over IPv6 are not supported. On systems with an IPv6 management network, you can use a separate IPv4 network for PXE boot. [#]_ |
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Intel Hyperthreading | Disabled or Enabled | | Intel Hyperthreading | Disabled or Enabled |
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Intel Virtualization \(VTD, VTX\) | Disabled | Enabled | | Intel Virtualization \(VTD, VTX\) | Disabled | Enabled |
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
.. [#] For more information, see :ref:`PXE Boot Network <network-planning-the-pxe-boot-network>`.
.. _starlingx-hardware-requirements-section-N102D0-N10024-N10001: .. _starlingx-hardware-requirements-section-N102D0-N10024-N10001:

52
doc/source/security/kubernetes/security-access-the-gui.rst
View File

@ -11,32 +11,36 @@ from a browser.
.. rubric:: |proc| .. rubric:: |proc|
.. _security-access-the-gui-steps-zdy-rxd-tkb: .. _security-access-the-gui-steps-zdy-rxd-tkb:
#. Do one of the following: * Do one of the following:
* **For the StarlingX Horizon Web interface**
Access the Horizon in your browser at the address:
http://<oam-floating-ip-address>:8080
Use the username **admin** and the sysadmin password to log in.
.. table:: * **For the Kubernetes Dashboard**
:widths: auto
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **For the StarlingX Horizon Web interface** | Access the Horizon in your browser at the address: |
| | |
| | http://<oam-floating-ip-address>:8080 |
| | |
| | Use the username **admin** and the sysadmin password to log in. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **For the Kubernetes Dashboard** | Access the Kubernetes Dashboard GUI in your browser at the address: |
| | |
| | http://<oam-floating-ip-address>:<kube-dashboard-port> |
| | |
| | Where <kube-dashboard-port> is the port that the dashboard was installed on. |
| | |
| | Login using credentials in kubectl config on your remote workstation running the browser; see :ref:`Install Kubectl and Helm Clients Directly on a Host <security-install-kubectl-and-helm-clients-directly-on-a-host>` as an example for setting up kubectl config credentials for an admin user. |
| | |
| | .. note:: |
| | The Kubernetes Dashboard is not installed by default. See |prod| System Configuration: :ref:`Install the Kubernetes Dashboard <install-the-kubernetes-dashboard>` for information on how to install the Kubernetes Dashboard and create a Kubernetes service account for the admin user to use the dashboard. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Access the Kubernetes Dashboard GUI in your browser at the address:
http://<oam-floating-ip-address>:<kube-dashboard-port>
Where <kube-dashboard-port> is the port that the dashboard was installed
on.
Login using credentials in kubectl config on your remote workstation
running the browser; see :ref:`Install Kubectl and Helm Clients Directly
on a Host <security-install-kubectl-and-helm-clients-directly-on-a-host>`
as an example for setting up kubectl config credentials for an admin
user.
.. note::
The Kubernetes Dashboard is not installed by default. See |prod|
System Configuration: :ref:`Install the Kubernetes Dashboard
<install-the-kubernetes-dashboard>` for information on how to install
the Kubernetes Dashboard and create a Kubernetes service account for
the admin user to use the dashboard.

7
doc/source/shared/abbrevs.txt
View File

@ -35,9 +35,11 @@
.. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)` .. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)`
.. |FQDNs| replace:: :abbr:`FQDNs (Fully Qualified Domain Names)` .. |FQDNs| replace:: :abbr:`FQDNs (Fully Qualified Domain Names)`
.. |GNP| replace:: :abbr:`GNP (Global Network Policy)` .. |GNP| replace:: :abbr:`GNP (Global Network Policy)`
.. |ICMP| replace:: :abbr:`ICMP (Internet Control Message Protocol)`
.. |IGMP| replace:: :abbr:`IGMP (Internet Group Management Protocol)` .. |IGMP| replace:: :abbr:`IGMP (Internet Group Management Protocol)`
.. |IoT| replace:: :abbr:`IoT (Internet of Things)` .. |IoT| replace:: :abbr:`IoT (Internet of Things)`
.. |IPMI| replace:: :abbr:`IPMI (Intelligent Platform Management Interface)` .. |IPMI| replace:: :abbr:`IPMI (Intelligent Platform Management Interface)`
.. |IOPS| replace:: :abbr:`IOPS (I/O operations per second)`
.. |LACP| replace:: :abbr:`LACP (Link Aggregation Control Protocol)` .. |LACP| replace:: :abbr:`LACP (Link Aggregation Control Protocol)`
.. |LAG| replace:: :abbr:`LAG (Link Aggregation)` .. |LAG| replace:: :abbr:`LAG (Link Aggregation)`
.. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)` .. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`
@ -49,6 +51,7 @@
.. |MNFA| replace:: :abbr:`MNFA (Multi-Node Failure Avoidance)` .. |MNFA| replace:: :abbr:`MNFA (Multi-Node Failure Avoidance)`
.. |MOTD| replace:: :abbr:`MOTD (Message of the Day)` .. |MOTD| replace:: :abbr:`MOTD (Message of the Day)`
.. |MTU| replace:: :abbr:`MTU (Maximum Transmission Unit)` .. |MTU| replace:: :abbr:`MTU (Maximum Transmission Unit)`
.. |NAT| replace:: :abbr:`NAT (Network Address Translation)`
.. |NIC| replace:: :abbr:`NIC (Network Interface Card)` .. |NIC| replace:: :abbr:`NIC (Network Interface Card)`
.. |NICs| replace:: :abbr:`NICs (Network Interface Cards)` .. |NICs| replace:: :abbr:`NICs (Network Interface Cards)`
.. |NTP| replace:: :abbr:`NTP (Network Time Protocol)` .. |NTP| replace:: :abbr:`NTP (Network Time Protocol)`
@ -73,6 +76,7 @@
.. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)` .. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)`
.. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)` .. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)`
.. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)` .. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)`
.. |PW| replace:: :abbr:`PW (Per Worker)`
.. |QoS| replace:: :abbr:`QoS (Quality of Service)` .. |QoS| replace:: :abbr:`QoS (Quality of Service)`
.. |RAID| replace:: :abbr:`RAID (Redundant Array of Inexpensive Disks)` .. |RAID| replace:: :abbr:`RAID (Redundant Array of Inexpensive Disks)`
.. |RBAC| replace:: :abbr:`RBAC (Role-Based Access Control)` .. |RBAC| replace:: :abbr:`RBAC (Role-Based Access Control)`
@ -81,6 +85,7 @@
.. |SANs| replace:: :abbr:`SANs (Subject Alternative Names)` .. |SANs| replace:: :abbr:`SANs (Subject Alternative Names)`
.. |SAS| replace:: :abbr:`SAS (Serial Attached SCSI)` .. |SAS| replace:: :abbr:`SAS (Serial Attached SCSI)`
.. |SATA| replace:: :abbr:`SATA (Serial AT Attachment)` .. |SATA| replace:: :abbr:`SATA (Serial AT Attachment)`
.. |SCTP| replace:: :abbr:`SCTP (Stream Control Transmission Protocol)`
.. |SLA| replace:: :abbr:`SLA (Service Level Agreement)` .. |SLA| replace:: :abbr:`SLA (Service Level Agreement)`
.. |SLAs| replace:: :abbr:`SLAs (Service Level Agreements)` .. |SLAs| replace:: :abbr:`SLAs (Service Level Agreements)`
.. |SM| replace:: :abbr:`SM (Service Manager)` .. |SM| replace:: :abbr:`SM (Service Manager)`
@ -93,6 +98,7 @@
.. |SSH| replace:: :abbr:`SSH (Secure Shell)` .. |SSH| replace:: :abbr:`SSH (Secure Shell)`
.. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)` .. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)`
.. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)` .. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)`
.. |TCP| replace:: :abbr:`TCP (Transition Control Protocol)`
.. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)` .. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)`
.. |TLS| replace:: :abbr:`TLS (Transport Layer Security)` .. |TLS| replace:: :abbr:`TLS (Transport Layer Security)`
.. |ToR| replace:: :abbr:`ToR (Top-of-Rack)` .. |ToR| replace:: :abbr:`ToR (Top-of-Rack)`
@ -111,6 +117,7 @@
.. |VNI| replace:: :abbr:`VNI (VXLAN Network Interface)` .. |VNI| replace:: :abbr:`VNI (VXLAN Network Interface)`
.. |VNIs| replace:: :abbr:`VNIs (VXLAN Network Interfaces)` .. |VNIs| replace:: :abbr:`VNIs (VXLAN Network Interfaces)`
.. |VPC| replace:: :abbr:`VPC (Virtual Port Channel)` .. |VPC| replace:: :abbr:`VPC (Virtual Port Channel)`
.. |vRAN| replace:: :abbr:`vRAN (virtualized Radio Access Network)`
.. |VXLAN| replace:: :abbr:`VXLAN (Virtual eXtensible Local Area Network)` .. |VXLAN| replace:: :abbr:`VXLAN (Virtual eXtensible Local Area Network)`
.. |VXLANs| replace:: :abbr:`VXLANs (Virtual eXtensible Local Area Networks)` .. |VXLANs| replace:: :abbr:`VXLANs (Virtual eXtensible Local Area Networks)`
.. |XML| replace:: :abbr:`XML (eXtensible Markup Language)` .. |XML| replace:: :abbr:`XML (eXtensible Markup Language)`