diff --git a/docconf/docconf/__init__.py b/docconf/docconf/__init__.py index e69de29b..c2094d9f 100644 --- a/docconf/docconf/__init__.py +++ b/docconf/docconf/__init__.py @@ -0,0 +1,2 @@ +# Expose config variables for Sphinx conf.py imports +from .docconf import version, release, project, author, copyright, warning_is_error, extensions, templates_path, exclude_patterns, source_suffix, source_encoding, language, master_doc, rst_epilog, myst_substitutions, autosectionlabel_prefix_document, autosectionlabel_maxdepth, linkcheck_ignore, linkcheck_request_headers, linkcheck_timeout, linkcheck_retries, linkcheck_exclude_documents, spelling_word_list_filename, spelling_filters, spelling_exclude_patterns, html_theme, html_baseurl, html_favicon, html_static_path, html_show_sourcelink, html_show_sphinx, html_context, html_theme_options, myst_heading_anchors, suppress_warnings, myst_enable_extensions diff --git a/docconf/docconf/__pycache__/__init__.cpython-313.pyc b/docconf/docconf/__pycache__/__init__.cpython-313.pyc new file mode 100644 index 00000000..8409766b Binary files /dev/null and b/docconf/docconf/__pycache__/__init__.cpython-313.pyc differ diff --git a/docconf/docconf/__pycache__/docconf.cpython-313.pyc b/docconf/docconf/__pycache__/docconf.cpython-313.pyc new file mode 100644 index 00000000..670f12dd Binary files /dev/null and b/docconf/docconf/__pycache__/docconf.cpython-313.pyc differ diff --git a/docs/_static/custom_sitemap.css b/docs/_static/custom_sitemap.css new file mode 100644 index 00000000..e6c1973c --- /dev/null +++ b/docs/_static/custom_sitemap.css @@ -0,0 +1,17 @@ +/* Custom styles for interactive sitemap */ +.sitemap-list { + list-style: none; + padding-left: 0; +} +.sitemap-list li { + margin: 0.2em 0; +} +.sitemap-toggle { + cursor: pointer; + font-weight: bold; + margin-right: 0.3em; +} +.sitemap-children { + margin-left: 1.5em; + display: none; +} diff --git a/docs/_static/custom_sitemap.js b/docs/_static/custom_sitemap.js new file mode 100644 index 00000000..e00df706 --- /dev/null +++ b/docs/_static/custom_sitemap.js @@ -0,0 +1,18 @@ +// Custom interactive sitemap JS for Sphinx +// Simple collapsible tree for sitemap page + +document.addEventListener('DOMContentLoaded', function() { + var togglers = document.querySelectorAll('.sitemap-toggle'); + togglers.forEach(function(toggler) { + toggler.addEventListener('click', function() { + var target = document.getElementById(this.dataset.target); + if (target.style.display === 'none') { + target.style.display = 'block'; + this.textContent = '▼'; + } else { + target.style.display = 'none'; + this.textContent = '▶'; + } + }); + }); +}); diff --git a/docs/api/index.rst b/docs/api/index.rst index 96ce5176..eb64ef5c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,9 +1,12 @@ + APIs ==== The following APIs are available for the Edge Orchestrator: .. toctree:: + :maxdepth: 2 + :caption: API Reference alerting_monitor app_catalog diff --git a/docs/conf.py b/docs/conf.py index 1d77718b..5898a073 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ if os.environ.get("SIMPLE_MODE") == "true": from docconf import docconf_simple as docconf else: - from docconf import docconf + from docconf.docconf import version, release, project, author, copyright, warning_is_error, extensions, templates_path, exclude_patterns, source_suffix, source_encoding, language, master_doc, rst_epilog, myst_substitutions, autosectionlabel_prefix_document, autosectionlabel_maxdepth, linkcheck_ignore, linkcheck_request_headers, linkcheck_timeout, linkcheck_retries, linkcheck_exclude_documents, spelling_word_list_filename, spelling_filters, spelling_exclude_patterns, html_theme, html_baseurl, html_favicon, html_static_path, html_show_sourcelink, html_show_sphinx, html_context, html_theme_options, myst_heading_anchors, suppress_warnings, myst_enable_extensions # sphinx doesn't use UPPER_CASE naming style for constants # pylint: disable=invalid-name @@ -26,52 +26,34 @@ # make changes to the docconf module - see the repo README for further # instructions. -version = docconf.version -release = docconf.release -project = docconf.project -author = docconf.author -copyright = docconf.copyright # pylint: disable=redefined-builtin - -warning_is_error = docconf.warning_is_error - -extensions = docconf.extensions - -templates_path = docconf.templates_path -exclude_patterns = docconf.exclude_patterns - -source_suffix = docconf.source_suffix -source_encoding = docconf.source_encoding - -language = docconf.language -master_doc = docconf.master_doc -rst_epilog = docconf.rst_epilog -myst_substitutions = docconf.myst_substitutions - -autosectionlabel_prefix_document = docconf.autosectionlabel_prefix_document -autosectionlabel_maxdepth = docconf.autosectionlabel_maxdepth - -linkcheck_ignore = docconf.linkcheck_ignore -linkcheck_request_headers = docconf.linkcheck_request_headers -linkcheck_timeout = docconf.linkcheck_timeout -linkcheck_retries = docconf.linkcheck_retries -linkcheck_exclude_documents = docconf.linkcheck_exclude_documents - -spelling_word_list_filename = docconf.spelling_word_list_filename -spelling_filters = docconf.spelling_filters -spelling_exclude_patterns = docconf.spelling_exclude_patterns - -html_theme = docconf.html_theme - -html_baseurl = docconf.html_baseurl -html_favicon = docconf.html_favicon -html_static_path = docconf.html_static_path -html_show_sourcelink = docconf.html_show_sourcelink -html_show_sphinx = docconf.html_show_sphinx - -html_context = docconf.html_context -html_theme_options = docconf.html_theme_options - -# Configure myst_parser (only used by docconf_simple) -myst_heading_anchors = docconf.myst_heading_anchors -suppress_warnings = docconf.suppress_warnings -myst_enable_extensions = docconf.myst_enable_extensions +## Use direct imports for local builds +## (see import above) + +## Remove all references to 'docconf.' prefix for local builds +source_suffix = source_suffix +source_encoding = source_encoding +language = language +master_doc = master_doc +rst_epilog = rst_epilog +myst_substitutions = myst_substitutions +autosectionlabel_prefix_document = autosectionlabel_prefix_document +autosectionlabel_maxdepth = autosectionlabel_maxdepth +linkcheck_ignore = linkcheck_ignore +linkcheck_request_headers = linkcheck_request_headers +linkcheck_timeout = linkcheck_timeout +linkcheck_retries = linkcheck_retries +linkcheck_exclude_documents = linkcheck_exclude_documents +spelling_word_list_filename = spelling_word_list_filename +spelling_filters = spelling_filters +spelling_exclude_patterns = spelling_exclude_patterns +html_theme = html_theme +html_baseurl = html_baseurl +html_favicon = html_favicon +html_static_path = html_static_path +html_show_sourcelink = html_show_sourcelink +html_show_sphinx = html_show_sphinx +html_context = html_context +html_theme_options = html_theme_options +myst_heading_anchors = myst_heading_anchors +suppress_warnings = suppress_warnings +myst_enable_extensions = myst_enable_extensions diff --git a/docs/deployment_guide/index.rst b/docs/deployment_guide/index.rst index 5729ea10..cdbadd3e 100644 --- a/docs/deployment_guide/index.rst +++ b/docs/deployment_guide/index.rst @@ -1,18 +1,17 @@ + Deployment Guide ================ -You have the flexibility to deploy our |software_prod_name|\ using either -Amazon Web Services\* (AWS\*) cloud or on-premises infrastructure, depending on -your specific needs and preferences. - -To get started, refer to the following sections for detailed instructions and -guidance tailored to each deployment option. +You have the flexibility to deploy |software_prod_name| using either Amazon Web Services* (AWS*) cloud or on-premises infrastructure. -* :doc:`cloud_deployment/index` -* :doc:`on_prem_deployment/index` +**Deployment Guide Navigation** .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Deployment Guide Contents cloud_deployment/index on_prem_deployment/index + +**Section Overview** + diff --git a/docs/developer_guide/index.rst b/docs/developer_guide/index.rst index 0e176e4d..9708928d 100644 --- a/docs/developer_guide/index.rst +++ b/docs/developer_guide/index.rst @@ -1,67 +1,22 @@ Developer Guide =============== -|software_prod_name|, part of the Open Edge Platform, brings the ease -of cloud-native deployment, orchestration, and management to edge environments, -at scale. +|software_prod_name|, part of the Open Edge Platform, brings the ease of cloud-native deployment, orchestration, and management to edge environments at scale. -.. figure:: images/edge_platform_arch.png - :alt: High-Level Architecture of Open Edge Platform |software_prod_name| +**Developer Guide Navigation** +**Developer Guide Navigation** +------------------------------ -Cloud computing abstracts away details of the underlying computing devices. In -contrast, edge networks often require heterogeneous and specific hosts. You may -need purpose-built equipment for networking, retail, or factory control in your -edge. Alternatively, you may need to run AI models that have been optimized for -performance on a specific class of devices. - -Additionally, hosts in an edge network may also have limited memory or compute -power. They may be situated in remote environments that are hard to reach or in -locations with physical security concerns. |software_prod_name| addresses -the challenges of edge computing, streamlining the management of edge -networks at scale. - -|software_prod_name| consists of seven main components, deployable on-premises -or in the cloud: - -* **Edge Node Agents**: A set of agents that run on the edge nodes as OS-level agents. - They communicate with the services running in the |software_prod_name| and provide a - consistent interface for the edge node software. Read more about :doc:`agents/index`. - -* **Edge Infrastructure Manager**: Policy-based, secure lifecycle management - of a fleet of edge nodes/devices at scale, spread across distributed locations - allowing onboarding, provisioning, inventory management, upgrades and more. - Read more about :doc:`infra_manager/index`. - -* **Edge Cluster Orchestrator**: A lightweight multi-cluster orchestrator based - on the Cluster API (CAPI) standard, designed to automate the deployment and - lifecycle management of Kubernetes\* clusters at scale across distributed - edges, providing centralized monitoring and access control. - Read more about :doc:`cluster_orch/index`. - -* **Edge Application Orchestrator**: Offers customers the ability to easily - package, deploy and monitor cloud-native applications at scale across - distributed edges. Read more about :doc:`app_orch/index`. - -* **User Interface**: The web user interface for the Edge Orchestrator, allowing - the user to manage most of the features of the product in an intuitive, - visual, manner without having to trigger a series of APIs individually. - -* **Observability**: A modular observability stack that provides visibility into - the health and performance of the system, including logging, reporting, - alerts, and SRE data from Edge Orchestrator components and Edge Nodes. - Read more about :doc:`observability/index`. - -* **Platform Services**: A collection of services that support the deployment - and management of Edge Orchestrator, including Identity and Access - management, multitenancy management, ingress route configuration, secrets - and certificate management, cloud and on-prem infrastructure lifecycle - management and more. Read more about :doc:`platform/index`. - -All of the components are exposed via a seamless, consistent, intuitive, and -delightful user experience. - -|software_prod_name| also includes software that gets installed into the Edge -Node called **Edge Node Agents**. +.. toctree:: + :maxdepth: 2 + :caption: Developer Guide Contents + + platform/index + observability/index + virtual_edge_node/index + trusted_compute/index + contributor_guide/index + application_developer_workflow/index All of the artifacts needed to deploy |software_prod_name| and the Edge Nodes are published in the Release Service. diff --git a/docs/index.rst b/docs/index.rst index e1d9a837..b3d95107 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,128 +1,57 @@ -:html_theme.sidebar_secondary.remove: |software_prod_name| Documentation ================================== -Explore documentation to set up and use Edge Orchestrator. +Welcome to the Edge Orchestrator documentation. Use the sections below to find guides, references, and resources for deploying, using, and developing with Edge Orchestrator. -Deploy Edge Orchestrator ------------------------- -Review system requirements and then select your deployment type: AWS\* Cloud or On-Premises. - -.. grid:: 3 - - .. grid-item-card:: Check System Requirements - :link: system_requirements/index - :link-type: doc - :link-alt: clickable cards - - Review the minimum edge node hardware requirements and supported browsers. - - .. grid-item-card:: Deploy Edge Orchestrator on AWS* Cloud - :link: deployment_guide/cloud_deployment/cloud_get_started/index - :link-type: doc - :link-alt: clickable cards - - Host Edge Orchestrator on a Cloud environment. - - .. grid-item-card:: Deploy Edge Orchestrator On-Premises - :link: deployment_guide/on_prem_deployment/on_prem_get_started/index - :link-type: doc - :link-alt: clickable cards - - Host Edge Orchestrator on a single machine. - - -Use Edge Orchestrator ---------------------- -Find everything you need to get up and running with Edge Orchestrator. Learn how it works, and then -prepare hardware for deployment, package and deploy applications, monitor the health of your network, and more. - -.. grid:: 3 - - .. grid-item-card:: Understand Edge Orchestrator - :link: user_guide/how_it_works/index - :link-type: doc - :link-alt: clickable cards - - Learn about how Edge Orchestrator works as part of the Open Edge Platform. - - .. grid-item-card:: Get Started - :link: user_guide/get_started_guide/index - :link-type: doc - :link-alt: clickable cards - - Follow the steps to get started using Edge Orchestrator. - - .. grid-item-card:: Set Up Infrastructure - :link: user_guide/set_up_edge_infra/index - :link-type: doc - :link-alt: clickable cards - - Prepare hardware for deployment. Onboard and configure hosts and create clusters. - -.. grid:: 3 - - .. grid-item-card:: Package Applications - :link: user_guide/package_software/index - :link-type: doc - :link-alt: clickable cards - - Import, package, and customize applications. - - .. grid-item-card:: Set Up a Deployment - :link: user_guide/package_software/setup_deploy - :link-type: doc - :link-alt: clickable cards - - Once you have a working platform with at least one edge cluster, deploy your first application. - - .. grid-item-card:: Dashboards and Alerts - :link: user_guide/monitor_deployments/index - :link-type: doc - :link-alt: clickable cards - - Monitor the health of hosts, applications, and deployments across your network. +.. toctree:: + :maxdepth: 2 + :caption: Quick Links + user_guide/get_started_guide/index + system_requirements/index + release_notes/index + user_guide/troubleshooting/index + sitemap -Develop Edge Orchestrator -------------------------- -Intel welcomes and encourages the community to contribute to the project. In the Developer Guide, -you can find details about the high-level design and submit patches of your own. +Deployment Guides +----------------- -.. grid:: 3 +- :doc:`Deploy on AWS Cloud ` +- :doc:`Deploy On-Premises ` +- :doc:`Deployment Guide Overview ` - .. grid-item-card:: Developer Guide - :link: developer_guide/index - :link-type: doc - :link-alt: clickable cards - Learn how to modify and extend the main components of Edge Orchestrator. +User Guides +----------- - .. grid-item-card:: Contributing - :link: developer_guide/contributor_guide/index - :link-type: doc - :link-alt: clickable cards +- :doc:`How it Works ` +- :doc:`Set Up Edge Infrastructure ` +- :doc:`Package and Deploy Applications ` +- :doc:`Dashboards and Alerts ` +- :doc:`Advanced Functionality ` +- :doc:`Administration ` +- :doc:`Concepts ` - Find guidelines for contributing to the project, including submitting issues and code. - .. grid-item-card:: APIs - :link: api/index - :link-type: doc - :link-alt: clickable cards +Developer & API Docs +-------------------- - APIs offer Create, Read, Update, and Delete capabilities. +- :doc:`Developer Guide ` +- :doc:`Contributing ` +- :doc:`APIs ` .. toctree:: - :hidden: - - deployment_guide/index - user_guide/index - developer_guide/index - api/index - system_requirements/index - release_notes/index + :maxdepth: 2 + :caption: Full Documentation + + deployment_guide/index + user_guide/index + developer_guide/index + api/index + system_requirements/index + release_notes/index diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst index 744c0793..c516ba0b 100644 --- a/docs/release_notes/index.rst +++ b/docs/release_notes/index.rst @@ -1,30 +1,27 @@ + Release Notes ============= -In the following sections, you can stay up-to-date -with the latest enhancements, bug fixes, and -features introduced in our product. +In the following sections, you can stay up-to-date with the latest enhancements, bug fixes, and features introduced in our product. + +.. toctree:: + :maxdepth: 2 + :caption: Release Notes + + 3.0/version_3.0 + 3.1/version_3.1 -Version 3.0 ------------------- +**Version 3.0** - :doc:`/release_notes/3.0/rel_notes_3.0` - :doc:`/release_notes/3.0/kpi_3.0` - :doc:`/release_notes/3.0/third_party_components_3.0` - :doc:`/release_notes/3.0/containers_helm_charts_3.0` -Version 3.1 ------------------- +**Version 3.1** - :doc:`/release_notes/3.1/rel_notes_3.1` - :doc:`/release_notes/3.1/kpi_3.1` - :doc:`/release_notes/3.1/third_party_components_3.1` - :doc:`/release_notes/3.1/containers_helm_charts_3.1` - -.. toctree:: - :hidden: - - 3.0/version_3.0 - 3.1/version_3.1 - diff --git a/docs/sitemap.rst b/docs/sitemap.rst new file mode 100644 index 00000000..9fb79ed5 --- /dev/null +++ b/docs/sitemap.rst @@ -0,0 +1,153 @@ +Sitemap +======= + +Welcome to the Edge Orchestrator Documentation Sitemap. Use the links below to quickly navigate to any section of the documentation. + +.. raw:: html + + + +
+
+

Get Started

+ +
+
+

Release Notes

+ +
+
+

API Reference

+ +
+
+

Developer Guide

+ +
+
+

User Guide

+ +
+
diff --git a/docs/system_requirements/index.rst b/docs/system_requirements/index.rst index 95a98a44..a39ff42c 100644 --- a/docs/system_requirements/index.rst +++ b/docs/system_requirements/index.rst @@ -1,65 +1,45 @@ System Requirements =================== +.. toctree:: + :maxdepth: 2 + :caption: System Requirements + Edge Node Hardware Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------------- -|software_prod_name| does not mandate the use of these specific hardware SKUs. -It supports a wide variety of processors including Intel® Xeon® processors, -Intel® Core™ processors, Intel® Core™ Ultra processors and Intel® Atom™ -processors along with Intel® ARC™ graphics cards. -Actual hardware requirements depend on the desired applications performance -requirements that get deployed on the edge node. +|software_prod_name| does not mandate the use of these specific hardware SKUs. It supports a wide variety of processors including Intel® Xeon® processors, Intel® Core™ processors, Intel® Core™ Ultra processors and Intel® Atom™ processors along with Intel® ARC™ graphics cards. Actual hardware requirements depend on the desired applications performance requirements that get deployed on the edge node. Minimum hardware requirements for an edge node: -* CPU: - - * 3rd Gen or newer Intel® Xeon® Processor +* **CPU:** + * 3rd Gen or newer Intel® Xeon® Processor * 12th Gen or newer Intel® Core™ or Core Ultra Processor * 8th Gen or newer Intel® Atom® Processor * 4 cores minimum - -* RAM 8GB - -* Storage - +* **RAM:** 8GB +* **Storage:** * 1 Dedicated Data disk with minimum capacity of 100GiB(*) * SSD, NVME and SATA disk types - * Priority order for provisioning is SSD, NVME, SATA. If multiple disk - have the same name and type the smaller size one is selected. - -* Network interface Card Supported by inbox Linux kernel drivers (one of): - - * Intel® Ethernet Network Adapter - `X710 family `_ - * Intel® Ethernet Network Adapter - `E810 family `_\ , - recommended firmware version `22.5.7` + * Priority order for provisioning is SSD, NVME, SATA. If multiple disks have the same name and type, the smaller size one is selected. +* **Network interface Card** supported by inbox Linux kernel drivers (one of): + * Intel® Ethernet Network Adapter `X710 family `_ + * Intel® Ethernet Network Adapter `E810 family `_, recommended firmware version `22.5.7` * Intel® Ethernet Network Onboard Core Network Adapters - * `i226 & i226-V `_ * `i225-V & i225-LM `_ - - * Broadcom\* LAN On Motherboard (LOM), validated with BCM57504 card - -* Network - + * Broadcom* LAN On Motherboard (LOM), validated with BCM57504 card +* **Network:** * Connectivity outbound to the centralized |software_prod_name| software. * Connectivity outbound to the public Internet. - * Upstream 1 Gbps bandwidth is preferred, but 512 Mbps has also been - validated. - -* Boot mechanism (either one of the two) - - * USB boot - * HTTPs boot if fully remote provisioning is required. + * Upstream 1 Gbps bandwidth is preferred, but 512 Mbps has also been validated. -* BIOS version 1.12.1 or higher (if supported) for Dell devices +* **Boot mechanism** (either one of the two): + * USB boot + * HTTPs boot if fully remote provisioning is required. +* **BIOS version:** 1.12.1 or higher (if supported) for Dell devices -.. note:: - Actual resource requirements will widely vary depending on user deployed - applications (for example, AI inferencing) + Actual resource requirements will widely vary depending on user deployed applications (for example, AI inferencing) Validated Hardware ^^^^^^^^^^^^^^^^^^ diff --git a/docs/user_guide/advanced_functionality/index.rst b/docs/user_guide/advanced_functionality/index.rst index 35b6ae33..f19c34bd 100644 --- a/docs/user_guide/advanced_functionality/index.rst +++ b/docs/user_guide/advanced_functionality/index.rst @@ -1,33 +1,19 @@ Advanced Functionality -========================================== - -In addition to the main tasks outlined in this user guide, these are -more advanced tasks such as administrative ones to customize or extend the -application's capabilities: - - * :doc:`/user_guide/advanced_functionality/set_up_a_cluster_template` - * :doc:`/user_guide/advanced_functionality/automated_deployment` - * :doc:`/user_guide/advanced_functionality/view_os_profiles` - * :doc:`/user_guide/advanced_functionality/alerts_config` - * :doc:`/user_guide/advanced_functionality/host_schedule_main` - * :doc:`/user_guide/advanced_functionality/install_new_packages` - * :doc:`/user_guide/advanced_functionality/host_update_immutable_os` - * :doc:`/user_guide/advanced_functionality/configure_ssh_public_keys` - * :doc:`/user_guide/advanced_functionality/oxm_pxe_provisioning` - * :doc:`/user_guide/advanced_functionality/pxe_provisioning_with_cloud_emf` - * :doc:`/user_guide/advanced_functionality/custom_config` +====================== +In addition to the main tasks outlined in this user guide, these are more advanced tasks such as administrative ones to customize or extend the application's capabilities: .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Advanced Functionality set_up_a_cluster_template + automated_deployment view_os_profiles alerts_config host_schedule_main install_new_packages host_update_immutable_os - automated_deployment configure_ssh_public_keys oxm_pxe_provisioning pxe_provisioning_with_cloud_emf diff --git a/docs/user_guide/concepts/index.rst b/docs/user_guide/concepts/index.rst index 0bf2720c..f3c00c57 100644 --- a/docs/user_guide/concepts/index.rst +++ b/docs/user_guide/concepts/index.rst @@ -1,32 +1,16 @@ Concepts ======== -The Concepts section provides some key concepts, explanation, and examples that -will help you to work effectively with |software_prod_name|. - -This section explains the following: - -* :doc:`metadata_example` - -* :doc:`/user_guide/concepts/cluster_usergroups` - -* :doc:`/shared/shared_os_profile`. You can also refer to the - :doc:`/api/edge_infra_manager` API. - -* :doc:`nztp` - -* :doc:`/shared/shared_update_provider`. You can also refer to the - :doc:`/api/edge_infra_manager` API. - -* :doc:`/shared/shared_secure_boot_opt_in` +The Concepts section provides some key concepts, explanation, and examples that will help you to work effectively with |software_prod_name|. .. toctree:: - :hidden: - - metadata_example - cluster_usergroups - ../../shared/shared_os_profile - nztp - ../../shared/shared_update_provider - ../../shared/shared_secure_boot_opt_in + :maxdepth: 2 + :caption: Concepts + + metadata_example + cluster_usergroups + ../../shared/shared_os_profile + nztp + ../../shared/shared_update_provider + ../../shared/shared_secure_boot_opt_in diff --git a/docs/user_guide/get_started_guide/index.rst b/docs/user_guide/get_started_guide/index.rst index 5511efd8..492c5bcc 100644 --- a/docs/user_guide/get_started_guide/index.rst +++ b/docs/user_guide/get_started_guide/index.rst @@ -1,34 +1,23 @@ + Get Started -=========================== +=========== -This section will to help you become familiar with |software_prod_name|. +This section will help you become familiar with |software_prod_name|. -|software_prod_name| is a multi-tenant system, see :doc:`/shared/shared_mt_overview` for a multi-tenancy overview. +.. toctree:: + :maxdepth: 2 + :caption: Get Started -Hardware Requirements ----------------------------- -|software_prod_name| support a plethora of Intel® platforms, including Core™, -Intel® Xeon® and Intel® Atom® processor families. -For detailed edge-node system requirements, see :doc:`/system_requirements/index`. -If you have a specific system configuration and you want to discuss it, -reach out to the development team. + /shared/shared_mt_overview + /user_guide/set_up_edge_infra/location/index + /user_guide/advanced_functionality/set_default_cluster_template + /user_guide/set_up_edge_infra/edge_node_onboard/3rd_party_examples/setup_loca -Quick Start ------------------- +**Hardware Requirements** +------------------------ +|software_prod_name| supports a plethora of Intel® platforms, including Core™, Intel® Xeon® and Intel® Atom® processor families. +For detailed edge-node system requirements, see :doc:`/system_requirements/index`. +If you have a specific system configuration and you want to discuss it, reach out to the development team. .. figure:: ./images/get_started.png - :alt: Get Started - -Initial Configuration ----------------------------------------------- - -You must configure the following before -working with |software_prod_name|: - -- :doc:`/shared/shared_mt_overview` to create Organizations and Projects -- :doc:`/user_guide/set_up_edge_infra/location/index` -- :doc:`/user_guide/advanced_functionality/set_default_cluster_template` - -If you are deploying LOC-A with |software_prod_name|: - -- :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/3rd_party_examples/setup_loca` + :alt: Get Started diff --git a/docs/user_guide/how_it_works/index.rst b/docs/user_guide/how_it_works/index.rst index 0134c519..4940636c 100644 --- a/docs/user_guide/how_it_works/index.rst +++ b/docs/user_guide/how_it_works/index.rst @@ -1,51 +1,18 @@ + How it Works ============ -Edge Manageability Framework is the primary solution to manage edge environments -efficiently and securely. It encompasses a range of features that cater to the -unique demands of edge computing, ensuring seamless integration and operation -across diverse hardware and software landscapes. - -Edge Manageability Framework is designed to be the central hub for managing -edge infrastructure and edge application deployments at scale across -geographically distributed edge sites. It offers automated application -deployment based on customer-defined configuration & criteria, multitenancy -and identity & access management for tenants, observability & alerting -capabilities, dashboards for quick views of status & issue identification, -and management of all software deployments & infrastructure components including -edge nodes (i.e. hosts) and clusters. - -At a high level, this is how you can use Edge Orchestrator. - - .. figure:: ./images/how_it_works2.png - :alt: How it works - -The :doc:`Get Started Guide ` provides -you with a step by step process to use the system. - -If instead you are directly interested in one of the orchestrator functionality -you can use one of the following steps: - -1. :doc:`/user_guide/set_up_edge_infra/index`: Leverage Edge Orchestrator’s fleet -management and cluster orchestration capabilities to onboard and configure -hosts and form them into clusters. - -2. :doc:`/user_guide/package_software/index`: Use Edge Orchestrator’s application -orchestration features to import and package applications. Create profiles to -customize deploy-time environments. Configure conditions for automated -deployment. +Edge Manageability Framework is the primary solution to manage edge environments efficiently and securely. It encompasses a range of features that cater to the unique demands of edge computing, ensuring seamless integration and operation across diverse hardware and software landscapes. -3. **Deploy to Edge Automatically**: Packages are deployed to clusters based on -metadata, or to lists of custom targets. Edge Orchestrator automatically -distributes software updates and deploys the latest packages to new hosts as -they onboard. +.. toctree:: + :maxdepth: 2 + :caption: How it Works -4. :doc:`/user_guide/monitor_deployments/index`: Observability features are woven throughout Edge -Orchestrator. Performance monitoring and alerting highlight critical issues, -while the unified dashboard offers visibility across the entire edge stack. + /user_guide/set_up_edge_infra/index + /user_guide/package_software/index + /user_guide/monitor_deployments/index - For more details, see: +.. figure:: ./images/how_it_works2.png + :alt: How it works -• :doc:`/user_guide/set_up_edge_infra/index` -• :doc:`/user_guide/package_software/index` -• :doc:`/user_guide/monitor_deployments/index` +The :doc:`Get Started Guide ` provides you with a step by step process to use the system. diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst index 1e218208..fb4b4323 100644 --- a/docs/user_guide/index.rst +++ b/docs/user_guide/index.rst @@ -1,41 +1,36 @@ User Guide ========== -|software_prod_name|, part of Intel's Edge Platform, simplifies edge -application deployment and management, making it easier to deploy edge -solutions at scale. |software_prod_name| provides: +|software_prod_name|, part of Intel's Edge Platform, simplifies edge application deployment and management, making it easier to deploy edge solutions at scale. -- **Secure Infrastructure Management**: Offers secure and efficient remote - onboarding and management of your edge node fleet, across sites and - geographies. Zero-trust security configuration reduces the time required to protect your edge applications. +**User Guide Navigation** -- **Deployment Orchestration and Automation**: Lets you roll out and update - applications and configure infrastructure nodes across your network from a single pane of glass. |software_prod_name| provides automated cluster - orchestration and dynamic application deployment. - -- **Automated Deployment**: Automates the remote installation and updating of applications at scale. - -- **Deep Telemetry**: Gives you policy-based lifecycle management and - centralized visibility into your distributed edge infrastructure and - deployments. - -- **Flexible Configuration**: From organizing your physical - infrastructure to managing the permutations of executing applications in a variety of runtime environments, - |software_prod_name| gives you flexibility to define the policies, criteria, and hierarchies that make the most sense for your specific business needs. - -See the :doc:`Get Started section ` for prerequisites and steps -for initial configuration of the service. +------------------------ .. toctree:: - :hidden: - - how_it_works/index.rst - get_started_guide/index.rst - set_up_edge_infra/index.rst - package_software/index.rst - monitor_deployments/index.rst - intel_solutions/index.rst - advanced_functionality/index.rst - administration/index.rst - troubleshooting/index.rst - concepts/index.rst + :maxdepth: 2 + :caption: User Guide Contents + + get_started_guide/index + how_it_works/index + set_up_edge_infra/index + package_software/index + monitor_deployments/index + advanced_functionality/index + administration/index + troubleshooting/index + concepts/index + intel_solutions/index + +**Section Overview** + +- :doc:`Get Started ` +- :doc:`How it Works ` +- :doc:`Set Up Edge Infrastructure ` +- :doc:`Package and Deploy Applications ` +- :doc:`Dashboards and Alerts ` +- :doc:`Advanced Functionality ` +- :doc:`Administration ` +- :doc:`Troubleshooting ` +- :doc:`Concepts ` +- :doc:`Intel Solutions ` diff --git a/docs/user_guide/intel_solutions/index.rst b/docs/user_guide/intel_solutions/index.rst index 538d3c1d..f68d718d 100644 --- a/docs/user_guide/intel_solutions/index.rst +++ b/docs/user_guide/intel_solutions/index.rst @@ -1,10 +1,16 @@ + Deploy Intel Solutions -========================================================== +====================== + +This section guides you through the deployment of several Intel® solutions for the edge, including AI-Suites, and real-time applications on top of Intel® Open Edge Platform AI. + +.. toctree:: + :maxdepth: 2 + :caption: Intel Solutions -This section guides you through the deployment of several Intel® solutions for the edge, including AI-Suites, and -real-time applications on top of Intel® Open Edge Platform AI. +**External Intel Solution References:** -1. `Open Edge Intel Platform Software Catalog - Pallete Defect Detection Sample Application v2.3.0 `__. -2. `Open Edge Intel Platform Software Catalog - Image-Based Video Search Sample Application v1.0.0 `__. -3. `Open Edge Intel Platform Software Catalog - Chat Q&A Sample Application Sample Application v1.1.2 `__. +1. `Open Edge Intel Platform Software Catalog - Pallete Defect Detection Sample Application v2.3.0 `__ +2. `Open Edge Intel Platform Software Catalog - Image-Based Video Search Sample Application v1.0.0 `__ +3. `Open Edge Intel Platform Software Catalog - Chat Q&A Sample Application v1.1.2 `__ diff --git a/docs/user_guide/monitor_deployments/index.rst b/docs/user_guide/monitor_deployments/index.rst index b7372904..47b02958 100644 --- a/docs/user_guide/monitor_deployments/index.rst +++ b/docs/user_guide/monitor_deployments/index.rst @@ -1,19 +1,11 @@ Dashboard and Alerts -============================================= +==================== -Monitor the status of your deployments and the health of host infrastructure -from the |software_prod_name| dashboard and view the alerts in the -:doc:`Alerts ` page. -To configure alerts, :doc:`configure alerts ` page. - -* :doc:`/user_guide/monitor_deployments/status_deployment` -* :doc:`/user_guide/monitor_deployments/alerts_view` -* :doc:`/user_guide/monitor_deployments/grafana_content` -* :doc:`/user_guide/monitor_deployments/orchestrator_observability` -* :ref:`kpi` +Monitor the status of your deployments and the health of host infrastructure from the |software_prod_name| dashboard and view the alerts in the :doc:`Alerts ` page. To configure alerts, see :doc:`configure alerts `. .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Dashboards and Alerts status_deployment alerts_view diff --git a/docs/user_guide/package_software/index.rst b/docs/user_guide/package_software/index.rst index 5ca75612..1d9a8dd1 100644 --- a/docs/user_guide/package_software/index.rst +++ b/docs/user_guide/package_software/index.rst @@ -1,66 +1,28 @@ Package and Deploy Applications -==================================== +=============================== -For a quick introduction to the process of packaging and deploying -applications, see :doc:`/user_guide/package_software/quick_start_guide`. - -For a more detailed explanation of Application Orchestration see :doc:`/developer_guide/application_developer_workflow/index`. - -There is also a detailed tutorial on Application Orchestration that walks through the process developing an application -and packaging and deploying it. See :doc:`/developer_guide/app_orch/tutorials/index`. - -Preparing software for automated deployment involves these steps: - -1. Import applications - - Import apps to the service from |software_prod_name|\'s registry or from a public or private registry. External registries must be added to the service before first use. - - |software_prod_name| creates a default application profile for each app you - import. Application profiles let you define chart values that can be overridden at the time of deployment. - This lets you accommodate a range of runtime environments using a single deployment package. - - Alternatively, you can import a Helm Chart directly, skipping steps #1 and #2. See :doc:`/user_guide/package_software/import_helm_chart` for details. - -#. Package and customize applications - - Create a deployment package for each set of applications you want to deploy as a group. If your applications use multiple profiles, specify the profiles to use with this package. - -#. Optionally configure a Network to connect multiple applications - - Networks are an advanced feature that allows multiple applications deployed on separate clusters to communicate with each other. Networks are created using the Interconnect feature and - are described in :doc:`/user_guide/package_software/interconnect`. - -#. Configure the package for automated deployment - - Next, set up a deployment for the package. |software_prod_name| offers two methods of automated deployment: - - * In metadata-based deployment, you apply criteria used to automatically - deploy and update the package to clusters. As new clusters are added to the service, the package will automatically deploy to any that meet the criteria. - * Alternatively, you can target a custom set of clusters for the deployment. - - To configure your package for metadata-based deployment, add metadata keys and values to the package. - - To deploy to a custom set of clusters, create a list of target clusters. - - See :doc:`/user_guide/package_software/setup_deploy` for step-by-step instructions for configuring each type of deployment. - - For an end-to-end example of applying deployment metadata, see - :doc:`/user_guide/advanced_functionality/automated_deployment`. - - Once you have prepared both your infrastructure and software, |software_prod_name| automatically deploys it. - -After your software has been deployed, there are several options to manage it in :doc:`/user_guide/monitor_deployments/index`. - -You can use pre-curated deployment packages that extend edge clusters to provide enhanced operational capabilities. For more information, see -:doc:`/user_guide/package_software/extension_package`. +For a quick introduction to the process of packaging and deploying applications, see :doc:`/user_guide/package_software/quick_start_guide`. .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Package and Deploy Applications + quick_start_guide + import_helm_chart + interconnect + setup_deploy + extension_package registry applications deploy_packages deployments + +For a more detailed explanation of Application Orchestration see :doc:`/developer_guide/application_developer_workflow/index`. + +There is also a detailed tutorial on Application Orchestration that walks through the process developing an application and packaging and deploying it. See :doc:`/developer_guide/app_orch/tutorials/index`. + applications + deploy_packages + deployments extension_package quick_start_guide import_helm_chart diff --git a/docs/user_guide/set_up_edge_infra/index.rst b/docs/user_guide/set_up_edge_infra/index.rst index c3b5bccd..339c92ff 100644 --- a/docs/user_guide/set_up_edge_infra/index.rst +++ b/docs/user_guide/set_up_edge_infra/index.rst @@ -3,61 +3,29 @@ Set up Edge Infrastructure In Edge Infrastructure, "infrastructure" refers to: -- **Hosts**: Networked computing devices (edge nodes) that run workloads to provide applications or services. -- **Clusters**: One or multiple hosts that are grouped and work as a single unit. +- **Hosts**: Networked computing devices (edge nodes) that run workloads to provide applications or services. +- **Clusters**: One or multiple hosts that are grouped and work as a single unit. + +.. toctree:: + :maxdepth: 2 + :caption: Set Up Edge Infrastructure + + edge_node_onboard/index + edge_node_states/index + clusters/index + location/index **Prerequisites** Ensure that you have properly configured the :doc:`/user_guide/concepts/nztp`. -Before setting up your edge infrastructure within the service, you must onboard your -hosts by referring to the :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/index` section. -After onboarding your host(s), do the following to set up your edge infrastructure: +Before setting up your edge infrastructure within the service, you must onboard your hosts by referring to the :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/index` section. After onboarding your host(s), do the following to set up your edge infrastructure: #. :doc:`View Onboarded Hosts ` -#. :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/onboarding_actions/provision_host` - (not required in case of :doc:`Automated Onboarding and Provisioning `) +#. :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/onboarding_actions/provision_host` (not required in case of :doc:`Automated Onboarding and Provisioning `) #. :doc:`/user_guide/set_up_edge_infra/clusters/create_clusters` -If you have access to your edge node’s UUID or serial number, you can :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/edge_node_registration` -to facilitate faster onboarding. - -**Register Hosts** - -Registered hosts are hosts registered to the orchestrator but not yet connected or onboarded. -Registered hosts appear on the :doc:`/user_guide/set_up_edge_infra/edge_node_states/registered_hosts` page. -You must complete the onboarding before proceeding to the provisioning step. - -For more information see :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/edge_node_registration`. - -**Onboard Hosts** - -Onboarding is completed with the attestation of the edge nodes and enables -the host to connect to the backend services. Onboarded hosts appear on the -:doc:`/user_guide/set_up_edge_infra/edge_node_states/onboarded_hosts` page. -You must provision the hosts before adding them the cluster. - -For more information about onboarding hosts, see -:doc:`/user_guide/set_up_edge_infra/edge_node_onboard/index`. - -**Provision Hosts** - -To provision hosts, you must: - -- Select an operating system (OS) profile for the host. -- Select Secure Boot and Full Disk Encryption, if required. -- Associate the host to a site. - -Optionally: - -- add host labels allowing for host or hardware-specific application targeting. -- add SSH key to the host for Remote Access. - -Each host must be associated with a single site. Sites represent real-world locations and -can be grouped into regions. Regions can also be grouped, creating hierarchies, and helping -you to organize and manage your deployments. - -Intel recommends planning your region hierarchies ahead of time. See +If you have access to your edge node’s UUID or serial number, you can :doc:`/user_guide/set_up_edge_infra/edge_node_onboard/edge_node_registration` to facilitate faster onboarding. :doc:`/user_guide/set_up_edge_infra/location/index`. For more information on provisioning hosts, see the following sections: diff --git a/docs/user_guide/troubleshooting/index.rst b/docs/user_guide/troubleshooting/index.rst index aaaeb529..242ae419 100644 --- a/docs/user_guide/troubleshooting/index.rst +++ b/docs/user_guide/troubleshooting/index.rst @@ -1,27 +1,11 @@ Troubleshooting -========================================================== - -This section contains a set of issues and conditions the Intel team has -identified as conditions that can possibly occur with the release. This -is a draft document to point users who encounter the issues or conditions in -the right direction to help resolve them, or to contact Intel for support when -needed. - -Based on the feedback, Intel will refine these troubleshooting topics and -expand them to include step-by-step resolution guides. -If the `recover` section of the `Issue` does not provide meaningful information -and/or does not work as indented, contact Intel engineering and support. - - -* :doc:`/user_guide/troubleshooting/provision_issue` -* :doc:`/user_guide/troubleshooting/deploy_issue` -* :doc:`/user_guide/troubleshooting/operate_issues` -* :doc:`/user_guide/troubleshooting/management_issue` - +=============== +This section contains a set of issues and conditions the Intel team has identified as conditions that can possibly occur with the release. This is a draft document to point users who encounter the issues or conditions in the right direction to help resolve them, or to contact Intel for support when needed. .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Troubleshooting provision_issue deploy_issue