diff --git a/doc/source/introduction/deploy_config_overview.rst b/doc/source/introduction/deploy_config_overview.rst new file mode 100644 index 000000000..e54cdb77c --- /dev/null +++ b/doc/source/introduction/deploy_config_overview.rst @@ -0,0 +1,26 @@ + +.. pdk1580703255776 +.. _deploy_config_overview: + +================================== +Deployment Configurations Overview +================================== + +|prod-os| supports a variety of physical deployment options. + +It can scale very small with its |AIO| server solutions combining controller, +compute, and storage functions all on a single low-power / low-cost server. +|prod-os| can be deployed in both a single server |AIO|-Simplex solution as +well as an HA two server |AIO|-Duplex solution. The standard solution consists +of a two node HA Controller cluster, up to 9x node HA Storage Cluster and a +pool of up to 100 compute nodes. Finally, |prod-os| supports a +geographically-distributed multi-cloud solution for addressing cloud +requirements from the data center to the edge, with value-add cross-cloud +orchestration capabilities. In |prod|'s |prod-dc| deployment configuration, +|prod-os| is only supported on subclouds; there is no cross-subcloud +orchestration provided for |prod-os| on subclouds. + +.. image:: figures/eag1565612501060.png + + + diff --git a/doc/source/introduction/figures/eag1565612501060.png b/doc/source/introduction/figures/eag1565612501060.png new file mode 100644 index 000000000..187f41d82 Binary files /dev/null and b/doc/source/introduction/figures/eag1565612501060.png differ diff --git a/doc/source/introduction/figures/vzz1565620523528.png b/doc/source/introduction/figures/vzz1565620523528.png new file mode 100644 index 000000000..913947619 Binary files /dev/null and b/doc/source/introduction/figures/vzz1565620523528.png differ diff --git a/doc/source/introduction/functional_overview.rst b/doc/source/introduction/functional_overview.rst new file mode 100644 index 000000000..1e7be9c36 --- /dev/null +++ b/doc/source/introduction/functional_overview.rst @@ -0,0 +1,89 @@ + +.. hos1565619043403 +.. _functional_overview: + +=================== +Functional Overview +=================== + +|prod| includes a rich functionality set from open source projects. + +The high-level functional diagram of |prod| is shown in the diagram below: + +.. image:: figures/vzz1565620523528.png + +Where: + +.. _functional_overview-ul-izt-blh-s3b: + +**Hardened Linux** + A CentOS Linux Kernel and OS, tuned for performance and maintained with + security |CVE| patches. + +**Variety of open-source software supporting StarlingX and/or Kubernetes** + This includes packages such as Apache, Ceph, PostgreSql, Etcd, |IPMI|, + |TPM|, etc., as well as some services from OpenStack such as the + OpenStack Horizon Web interface, Keystone and Barbican. + +**StarlingX** + Hardware and software infrastructure management. + + - Manages installation, maintenance and fault monitoring of dedicated + bare metal servers running the |org| solution. + + - Manages the configuration of hardware and software services running + on the host servers. + + - Provides the cluster management for services running on the HA + master/control nodes cluster, as well critical software monitoring and + recovery of services running on all nodes within the cluster. + + - Monitoring and reporting of faults and logs of both hardware and + software services. + + - Support for managing software updates to all layers of software in + the solution; this includes kernel, operating system, open-source + packages, StarlingX and Kubernetes. + +**Kubernetes** + - Kubernetes Container Orchestration Engine + + - Native Docker Runtime + + - Calico Container Networking + + - Accelerated Container Networking with multus and |SRIOV| |CNIs| + + - Persistent Volume Claims backed by Ceph + + - Local Docker Registry + + - Helm / Tiller – Kubernetes Package Manager, and + + - Armada \(Airship\) + +**OpenStack** + - Keystone - Identity management + + - Nova - compute management + + - Neutron - network management + + - Glance - image management + + - Cinder - block storage + + - OpenStack Horizon - dashboard + + - Telemetry \(OPTIONAL\) + + - Panko - Event storage + + - Gnocchi - Time series database + + - Aodh - alarming + + - Heat - Orchestration + + + diff --git a/doc/source/introduction/index.rst b/doc/source/introduction/index.rst index ce7e751ce..18806fc75 100644 --- a/doc/source/introduction/index.rst +++ b/doc/source/introduction/index.rst @@ -28,8 +28,10 @@ Learn more about StarlingX: .. toctree:: :maxdepth: 1 - terms + functional_overview + deploy_config_overview deploy_options + terms consuming StarlingX Project Overview (PDF) diff --git a/doc/source/shared/abbrevs.txt b/doc/source/shared/abbrevs.txt index 2ccc297fe..ff9e4124c 100755 --- a/doc/source/shared/abbrevs.txt +++ b/doc/source/shared/abbrevs.txt @@ -22,6 +22,7 @@ .. |CLIs| replace:: :abbr:`CLIs (Command Line Interfaces)` .. |CMK| replace:: :abbr:`CMK (CPU Manager for Kubernetes)` .. |CNI| replace:: :abbr:`CNI (Container Networking Interface)` +.. |CNIs| replace:: :abbr:`CNIs (Container Networking Interfaces)` .. |CoW| replace:: :abbr:`CoW (Copy on Write)` .. |CSK| replace:: :abbr:`CSK (Code Signing Key)` .. |CSKs| replace:: :abbr:`CSKs (Code Signing Keys)`