├── .gitattributes ├── .github ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── PULL_REQUEST_TEMPLATE.md ├── SECURITY.md ├── dependabot.yml ├── labeler.yml └── workflows │ ├── labeler.yml │ ├── post-merge.yml │ ├── pre-merge.yml │ └── publish-docs.yml ├── .gitignore ├── LICENSES └── Apache-2.0.txt ├── Makefile ├── README.md ├── REUSE.toml ├── SECURITY.md ├── VERSION ├── dict.txt ├── docconf ├── docconf │ ├── __init__.py │ ├── docconf.py │ └── docconf_simple.py └── pyproject.toml ├── docs ├── _static │ ├── logo.svg │ └── one-edge-platform-login-title.png ├── api │ ├── alerting_monitor.rst │ ├── app_catalog.rst │ ├── app_deployment_manager.rst │ ├── app_resource_manager.rst │ ├── cluster_manager.rst │ ├── edge_infra_manager.rst │ ├── index.rst │ ├── metadata.rst │ ├── openapi │ │ ├── amc-app-orch-catalog-openapi.yaml │ │ ├── amc-app-orch-catalog-utilities-openapi.yaml │ │ ├── amc-app-orch-deployment-app-deployment-manager-openapi.yaml │ │ ├── amc-app-orch-deployment-app-resource-manager-openapi.yaml │ │ ├── amc-cluster-manager-openapi.yaml │ │ ├── amc-infra-core-edge-infrastructure-manager-openapi-all.yaml │ │ ├── amc-o11y-alerting-monitor-openapi.yaml │ │ ├── amc-orch-metadata-broker-openapi.yaml │ │ └── orch-utils.tenancy-datamodel.openapi.yaml │ └── tenancy.rst ├── conf.py ├── deployment_guide │ ├── cloud_deployment │ │ ├── cloud_advanced │ │ │ ├── cloud_alerts.rst │ │ │ ├── cloud_cluster_tmplt.rst │ │ │ ├── cloud_edge_node.rst │ │ │ ├── cloud_man_prereq.rst │ │ │ ├── cloud_manual_bp.rst │ │ │ ├── cloud_manual_dns.rst │ │ │ ├── cloud_manual_modules.rst │ │ │ ├── cloud_manual_terraconfig.rst │ │ │ ├── cloud_pull_through_cache.rst │ │ │ ├── cloud_resource_settings.rst │ │ │ ├── cloud_sre.rst │ │ │ └── index.rst │ │ ├── cloud_appendix │ │ │ ├── cloud_aws_iam_permissions.rst │ │ │ ├── cloud_cluster_autoscaling.rst │ │ │ ├── cloud_cluster_definition.rst │ │ │ ├── files │ │ │ │ ├── iam-policy-1.json │ │ │ │ ├── iam-policy-2.json │ │ │ │ └── iam-policy-3.json │ │ │ ├── images │ │ │ │ └── os_selection.png │ │ │ └── index.rst │ │ ├── cloud_examples │ │ │ ├── cloud_account.rst │ │ │ ├── cloud_buckets.rst │ │ │ ├── cloud_cluster.rst │ │ │ ├── cloud_flags.rst │ │ │ ├── cloud_loadbalancer.rst │ │ │ ├── cloud_route53.rst │ │ │ ├── cloud_vpcext.rst │ │ │ └── index.rst │ │ ├── cloud_get_started │ │ │ ├── cloud_certs.rst │ │ │ ├── cloud_orchestrator_install.rst │ │ │ ├── cloud_start_installer.rst │ │ │ ├── index.rst │ │ │ └── system_requirements_aws_orch.rst │ │ ├── cloud_how_to │ │ │ ├── cloud_cc_cred_refresh.rst │ │ │ ├── cloud_certificates.rst │ │ │ ├── cloud_scale_orch.rst │ │ │ ├── cloud_uninstall.rst │ │ │ └── index.rst │ │ ├── cloud_troubleshooting │ │ │ ├── cloud_ret_deploy_cont.rst │ │ │ └── index.rst │ │ └── index.rst │ ├── index.rst │ └── on_prem_deployment │ │ ├── images │ │ ├── on-prem-install-topology-config-with-corporate-proxy.png │ │ ├── on-prem-install-topology-config-with-squid-proxy.png │ │ ├── on-prem-install-topology-config.png │ │ ├── on-prem-loca-install-topology-config.png │ │ └── os_selection.png │ │ ├── index.rst │ │ ├── on_prem_appendix │ │ └── index.rst │ │ ├── on_prem_get_started │ │ ├── index.rst │ │ ├── on_prem_certs.rst │ │ ├── on_prem_install.rst │ │ └── system_requirements_on_prem_orch.rst │ │ ├── on_prem_how_to │ │ ├── index.rst │ │ ├── on_prem_alerts.rst │ │ ├── on_prem_certificates.rst │ │ ├── on_prem_sre.rst │ │ └── on_prem_uninstall.rst │ │ └── on_prem_troubleshooting │ │ └── index.rst ├── developer_guide │ ├── agents │ │ ├── arch │ │ │ ├── cluster.rst │ │ │ ├── edge_node.rst │ │ │ ├── hardware_discovery.rst │ │ │ ├── hl_architecture.rst │ │ │ ├── images │ │ │ │ ├── agents_stack.png │ │ │ │ ├── ca-architecture.drawio.svg │ │ │ │ ├── caddy-architecture.png │ │ │ │ ├── eim_arch.png │ │ │ │ ├── ena-architecture.png │ │ │ │ ├── hda-architecture.drawio.svg │ │ │ │ ├── na-architecture.drawio.svg │ │ │ │ ├── na-system.png │ │ │ │ ├── poa-architecture.drawio.svg │ │ │ │ ├── poa-system.png │ │ │ │ ├── pta-architecture.drawio.svg │ │ │ │ ├── pua-architecture.drawio.svg │ │ │ │ ├── pua-jwt.png │ │ │ │ └── pua-system.png │ │ │ ├── index.rst │ │ │ ├── platform_observability.rst │ │ │ ├── platform_telemetry.rst │ │ │ └── platform_update.rst │ │ ├── index.rst │ │ └── tutorials │ │ │ ├── developing │ │ │ ├── developing.rst │ │ │ └── index.rst │ │ │ └── index.rst │ ├── app_orch │ │ ├── arch │ │ │ ├── data_flow.rst │ │ │ ├── data_model.rst │ │ │ ├── deployment.rst │ │ │ ├── extensibility.rst │ │ │ ├── images │ │ │ │ ├── app-orch-data-model.png │ │ │ │ ├── application_deployment_workflow.svg │ │ │ │ ├── architecture-diagram.png │ │ │ │ ├── import_adm_grafana_dashboard.png │ │ │ │ ├── tech_stack_of_app_orch.svg │ │ │ │ └── view_adm_grafana_dashboard.png │ │ │ ├── index.rst │ │ │ ├── key_components.rst │ │ │ ├── performance.rst │ │ │ ├── persona_interaction.rst │ │ │ ├── scalability.rst │ │ │ ├── security.rst │ │ │ └── technology_stack.rst │ │ ├── index.rst │ │ └── tutorials │ │ │ ├── accessing-applications │ │ │ └── index.rst │ │ │ ├── deploying-applications │ │ │ ├── deploying.rst │ │ │ ├── import-dp.rst │ │ │ ├── index.rst │ │ │ └── pushing_charts_and_images.rst │ │ │ ├── deployment-helm │ │ │ ├── deployment-helm-tutorial-server.rst │ │ │ ├── deployment-helm-tutorial-web-ui.rst │ │ │ ├── index.rst │ │ │ └── routing-api-through-nginx.rst │ │ │ ├── deployment-packages │ │ │ └── index.rst │ │ │ ├── developing-applications │ │ │ ├── developing-tutorial-server.rst │ │ │ ├── developing-tutorial-web-ui.rst │ │ │ └── index.rst │ │ │ ├── images │ │ │ ├── app-orch-deploy-tutorial-2.png │ │ │ ├── app-orch-deploy-tutorial-3.png │ │ │ ├── app-orch-deploy-tutorial-6.png │ │ │ ├── app-orch-deploy-view.png │ │ │ ├── app-orch-edit-application.png │ │ │ ├── app-orch-edit-profile-tutorial-server.png │ │ │ ├── app-orch-edit-profile.png │ │ │ ├── app-orch-tutorial-app-imported.png │ │ │ ├── app-orch-tutorial-app-service-proxy.png │ │ │ ├── app-orch-tutorial-deployed.png │ │ │ ├── app-orch-tutorial-design.png │ │ │ ├── app-orch-tutorial-dp-imported.png │ │ │ ├── app-orch-tutorial-oci-registry.png │ │ │ ├── app-orch-tutorial-web-ui-fail.png │ │ │ ├── app-orch-tutorial-web-ui-helm.png │ │ │ ├── app-orch-tutorial-web-ui-nginx.png │ │ │ └── app-orch-tutorial-web-ui.png │ │ │ ├── index.rst │ │ │ └── packaging-applications │ │ │ ├── index.rst │ │ │ ├── packaging-tutorial-server.rst │ │ │ └── packaging-tutorial-web-ui.rst │ ├── application_developer_workflow │ │ ├── accessing-applications │ │ │ └── index.rst │ │ ├── deploying-applications │ │ │ └── index.rst │ │ ├── deployment-helm │ │ │ └── index.rst │ │ ├── deployment-packages │ │ │ ├── application-yaml-reference.rst │ │ │ ├── deployment-package-yaml-reference.rst │ │ │ ├── index.rst │ │ │ ├── reference-placeholders.rst │ │ │ └── registry-yaml-reference.rst │ │ ├── developing-applications │ │ │ └── index.rst │ │ ├── images │ │ │ ├── deployment-package-relationships.png │ │ │ └── helm-docker-oci-root-url.png │ │ ├── index.rst │ │ └── packaging-applications │ │ │ └── index.rst │ ├── cluster_orch │ │ ├── arch │ │ │ ├── architecture.rst │ │ │ ├── deployment.rst │ │ │ ├── images │ │ │ │ ├── co-2.0-capi-provider-intel.png │ │ │ │ ├── co-2.0-cluster-connect-gateway.png │ │ │ │ ├── co-2.0-day0.png │ │ │ │ ├── co-2.0-day1.png │ │ │ │ ├── co-2.0-day2-delete.png │ │ │ │ ├── co-2.0-ecm.png │ │ │ │ ├── co-2.0.png │ │ │ │ └── stack-diagram.png │ │ │ ├── index.rst │ │ │ ├── technology_stack.rst │ │ │ └── workflows.rst │ │ └── index.rst │ ├── contributor_guide │ │ ├── code_contribution.rst │ │ ├── conduct.rst │ │ ├── images │ │ │ ├── artifact-build.drawio.svg │ │ │ ├── branch.drawio.svg │ │ │ ├── submit-changes.drawio.png │ │ │ └── version_bump.drawio.svg │ │ ├── index.rst │ │ ├── make_workflow.rst │ │ ├── security.rst │ │ └── versioning.rst │ ├── images │ │ └── edge_platform_arch.png │ ├── index.rst │ ├── infra_manager │ │ ├── arch │ │ │ ├── background.rst │ │ │ ├── data_flow.rst │ │ │ ├── data_model.rst │ │ │ ├── day2_flow.rst │ │ │ ├── deployment.rst │ │ │ ├── extensibility.rst │ │ │ ├── hl_architecture.rst │ │ │ ├── images │ │ │ │ ├── eim_arch.png │ │ │ │ ├── eim_deployment.png │ │ │ │ ├── eim_flow.drawio.svg │ │ │ │ ├── eim_loca.png │ │ │ │ ├── eim_provisioning.png │ │ │ │ ├── eim_provisioning_detail.png │ │ │ │ ├── eim_provisioning_en_lifecycle.png │ │ │ │ └── eim_stack.png │ │ │ ├── index.rst │ │ │ ├── multi_tenancy.rst │ │ │ ├── overview.rst │ │ │ ├── provisioning.rst │ │ │ ├── scalability.rst │ │ │ └── security.rst │ │ ├── index.rst │ │ └── tutorials │ │ │ ├── index.rst │ │ │ ├── new_resource │ │ │ ├── api.rst │ │ │ ├── index.rst │ │ │ ├── inventory.rst │ │ │ └── multitenancy.rst │ │ │ ├── os_profiles │ │ │ ├── adding_os_profiles.rst │ │ │ ├── index.rst │ │ │ └── testing_custom_os_resource.rst │ │ │ └── upgrade │ │ │ ├── images │ │ │ ├── rollback-example.png │ │ │ └── rollback-tab.png │ │ │ ├── index.rst │ │ │ └── orch_upgrade.rst │ ├── observability │ │ ├── arch │ │ │ ├── concepts │ │ │ │ ├── images │ │ │ │ │ ├── obs_multi_data_access.svg │ │ │ │ │ └── obs_multi_data_ingestio_processing.svg │ │ │ │ ├── multitenancy.rst │ │ │ │ └── scalability.rst │ │ │ ├── edgenode │ │ │ │ ├── apps.rst │ │ │ │ ├── clusters.rst │ │ │ │ ├── hosts.rst │ │ │ │ └── images │ │ │ │ │ └── cluster_observability.svg │ │ │ ├── images │ │ │ │ └── overview.png │ │ │ ├── index.rst │ │ │ └── orchestrator │ │ │ │ ├── alerting-monitor.rst │ │ │ │ ├── edgenode-observability.rst │ │ │ │ ├── images │ │ │ │ ├── alerts-configuration.png │ │ │ │ ├── asynchronous_api_call_example_diagram.svg │ │ │ │ ├── diagram_edge_node_obs_stack.svg │ │ │ │ ├── diagram_orchestrator_node_obs_stack.svg │ │ │ │ ├── diagram_sre_exporter_operation.svg │ │ │ │ ├── diagram_ui_alerting.svg │ │ │ │ ├── reported-alerts.png │ │ │ │ ├── sre_exporter_data_flow.svg │ │ │ │ └── synchronous_api_call_example_diagram.svg │ │ │ │ ├── index.rst │ │ │ │ └── sre-exporter.rst │ │ ├── index.rst │ │ └── tutorials │ │ │ ├── development │ │ │ └── email-notifications.rst │ │ │ └── index.rst │ ├── platform │ │ ├── arch │ │ │ ├── argocd.rst │ │ │ ├── cloud_orchestrator.rst │ │ │ ├── images │ │ │ │ ├── argo-architecture.png │ │ │ │ ├── argo-config-flow.png │ │ │ │ ├── argo-config-flow2.png │ │ │ │ └── high-level-network-architecture-cloud.png │ │ │ ├── index.rst │ │ │ └── on_premise_orchestrator │ │ │ │ ├── data_flow.rst │ │ │ │ ├── deployment.rst │ │ │ │ ├── extensibility.rst │ │ │ │ ├── images │ │ │ │ ├── on-prem-high-level-architecture.png │ │ │ │ └── onPrem-services-architecture.png │ │ │ │ ├── index.rst │ │ │ │ ├── key_components.rst │ │ │ │ ├── scalability.rst │ │ │ │ ├── security.rst │ │ │ │ └── technology_stack.rst │ │ ├── buildall.rst │ │ └── index.rst │ ├── set_up_dev_env │ │ └── index.rst │ ├── troubleshooting │ │ ├── app_orch.rst │ │ ├── argocd.rst │ │ ├── capture_logs.rst │ │ ├── edge_cluster_orchestrator.rst │ │ ├── eks_node_issues.rst │ │ ├── hook_os.rst │ │ ├── images │ │ │ ├── agent-logs.png │ │ │ ├── audit_logs.png │ │ │ ├── bridge-network.png │ │ │ ├── co │ │ │ │ ├── cluster-obs.png │ │ │ │ ├── connectAgent.png │ │ │ │ ├── download_kubeconfig.png │ │ │ │ ├── edgeNodeAgent.png │ │ │ │ ├── exstenion-list.png │ │ │ │ ├── failing-ext-deployments.png │ │ │ │ ├── gitbjobcmd.png │ │ │ │ ├── healthyhost.png │ │ │ │ ├── import-deployment-package.png │ │ │ │ ├── kubectl-listPods.png │ │ │ │ ├── listresources.png │ │ │ │ ├── other-usage-kubeconfig.png │ │ │ │ ├── rkelog.png │ │ │ │ ├── short-lived-token-img.png │ │ │ │ ├── successful_clusterlist.png │ │ │ │ ├── upgrade-failing-deployment.png │ │ │ │ ├── url_of_kubeConfig.png │ │ │ │ └── viewMetrics.png │ │ │ ├── deployment-400.png │ │ │ ├── docker-limit.png │ │ │ ├── en-logs-details.png │ │ │ ├── en-logs.png │ │ │ ├── keycloak │ │ │ │ ├── keycloak-relm-export-options.png │ │ │ │ ├── keycloak-relm-import.png │ │ │ │ ├── keycloak-relm-partial-export.png │ │ │ │ ├── keycloak-relm-settings.png │ │ │ │ ├── keycloak-set-email.png │ │ │ │ ├── keycloak-set-password.png │ │ │ │ ├── keycloak-set-sso-30days.png │ │ │ │ ├── keycloak-set-sso-part2.png │ │ │ │ ├── keycloak-set-sso-part3.png │ │ │ │ └── keycloak-set-sso-part4.png │ │ │ ├── lb.svg │ │ │ ├── libvert-error.png │ │ │ ├── o11y │ │ │ │ ├── observability-admin-cluster-overview.jpeg │ │ │ │ ├── observability-admin-pod-list.png │ │ │ │ ├── observability-admin-pod-log-search.png │ │ │ │ ├── observability-admin-pod-resources.png │ │ │ │ ├── observability-admin-single-node.jpeg │ │ │ │ ├── observability-explore-edgenode-system.png │ │ │ │ ├── observability-grafana-login-error.png │ │ │ │ ├── observability-grafana-no-projects.png │ │ │ │ ├── observability-grafana-user-has-no-email.png │ │ │ │ └── orchestrator-admin-metrics-explorer.jpeg │ │ │ ├── obsdashboard.png │ │ │ ├── orch-logs.png │ │ │ ├── pod-logs.png │ │ │ ├── specific-en-logs.png │ │ │ ├── sre_exporter │ │ │ │ ├── sre-exporter-delete-pod.png │ │ │ │ └── sre-exporter-healthy.png │ │ │ ├── system-logs.png │ │ │ ├── ui │ │ │ │ ├── console-network-1.png │ │ │ │ ├── console-network-2.png │ │ │ │ ├── console-network-3.png │ │ │ │ ├── console-network-4.png │ │ │ │ ├── missing-registries.png │ │ │ │ └── missing-roles.png │ │ │ ├── user-groups.png │ │ │ ├── ven-max-vm.png │ │ │ └── visudo.png │ │ ├── inconsistent_state_infra_deployment.rst │ │ ├── index.rst │ │ ├── keycloak.rst │ │ ├── load_balancer.rst │ │ ├── o11y_access.rst │ │ ├── o11y_orchestrator.rst │ │ ├── sre_exporter.rst │ │ ├── ui.rst │ │ ├── vault.rst │ │ └── virtual_edge_node.rst │ ├── trusted_compute │ │ ├── arch │ │ │ ├── architecture.rst │ │ │ └── images │ │ │ │ ├── ContinuousMonitoring.png │ │ │ │ └── WorkloadProtection.png │ │ └── index.rst │ └── virtual_edge_node │ │ ├── arch │ │ ├── images │ │ │ ├── day0-prov-vm-wf.png │ │ │ ├── day1-destroy-vm-wf.png │ │ │ └── ven-design.png │ │ ├── index.rst │ │ ├── technology_stack.rst │ │ └── workflows.rst │ │ ├── deployment │ │ ├── baremetal_deployment.rst │ │ ├── cloud_deployment.rst │ │ ├── deployment.rst │ │ └── images │ │ │ └── kvm_not_supported.png │ │ ├── index.rst │ │ ├── tutorials │ │ ├── example1_io_flow.rst │ │ ├── example2_nio_default_serial_nums.rst │ │ ├── example3_nio_custom_serial_nums.rst │ │ ├── example4_auto_provision_false.rst │ │ ├── images │ │ │ ├── Microvisor_os_resource.png │ │ │ ├── Microvisor_provider.png │ │ │ ├── Ubuntu_os.png │ │ │ ├── Ubuntu_os_provider.png │ │ │ ├── autoProvision_false.png │ │ │ ├── autoProvision_true.png │ │ │ └── host-status.png │ │ └── index.rst │ │ └── usage │ │ ├── deploy_virtual_edge_node.rst │ │ ├── getting_started.rst │ │ ├── how_it_works_content.rst │ │ ├── images │ │ ├── Microvisor_Provision.png │ │ ├── Security_feature.png │ │ ├── UbuntuOS_Provision.png │ │ └── provider_config.png │ │ ├── index.rst │ │ ├── manage_virtual_edge_node.rst │ │ └── setup_virtual_edge_node.rst ├── index.rst ├── release_notes │ ├── containers_helm_charts_3.0.rst │ ├── index.rst │ ├── kpi_3.0.rst │ ├── rel_notes_3.0.rst │ ├── third_party_components_3.0.rst │ └── version_3.0.rst ├── shared │ ├── group_role_xy.csv │ ├── shared_adv_alerts.rst │ ├── shared_adv_edge_node.rst │ ├── shared_cloud_ts_sync_root_app.rst │ ├── shared_gs_firewall_config.rst │ ├── shared_gs_iam.rst │ ├── shared_gs_preinstall.rst │ ├── shared_howtos_advanced_settings.rst │ ├── shared_ht_iam_ext.rst │ ├── shared_ht_iam_groups.rst │ ├── shared_iam_groups.rst │ ├── shared_images │ │ ├── mt_project_complete.png │ │ ├── mt_project_create.png │ │ ├── mt_project_delete.png │ │ ├── mt_project_menu.png │ │ ├── mt_project_overview.png │ │ └── tenancy.drawio.png │ ├── shared_mt_overview.rst │ ├── shared_next_steps.rst │ ├── shared_on_prem_rke2_deployment.rst │ ├── shared_on_prem_rs_proxy.rst │ ├── shared_on_prem_ts_sync_root_app.rst │ ├── shared_on_prem_ts_vault_unseal.rst │ ├── shared_os_profile.rst │ ├── shared_registration_info_mismatch.rst │ ├── shared_secure_boot_opt_in.rst │ ├── shared_traefik_rate_limit.rst │ ├── shared_ts_cloud.rst │ ├── shared_ts_dkam_fail_state.rst │ ├── shared_ts_rs_token.rst │ ├── shared_ts_sriov_webhook.rst │ └── shared_update_provider.rst ├── substitutions.txt ├── system_requirements │ └── index.rst └── user_guide │ ├── additional_howtos │ ├── alerting.rst │ ├── alerts_config.rst │ ├── alerts_email.rst │ ├── automated_deployment.rst │ ├── configure_ssh_public_keys.rst │ ├── delete_cluster_template.rst │ ├── export_cluster_template.rst │ ├── host_schedule_main.rst │ ├── host_update_immutable_os.rst │ ├── images │ │ ├── add_ssh_key_menu.png │ │ ├── advanced_settings.png │ │ ├── alerts │ │ │ ├── EO-alert-definitions.png │ │ │ ├── EO-alert-details.png │ │ │ ├── EO-alert-list.png │ │ │ └── EO-email-config.png │ │ ├── cluster_details1.png │ │ ├── cluster_template.png │ │ ├── contextual_maintenance_menu_region.png │ │ ├── contextual_region_add_maintenance.png │ │ ├── create_cluster.png │ │ ├── default_cluster_template.png │ │ ├── delete_customer_template.png │ │ ├── delete_deploy.png │ │ ├── delete_ssh_key_menu.png │ │ ├── deployment_metadata.png │ │ ├── deployments_main.png │ │ ├── export_cluster_template.png │ │ ├── import_cluster_template.png │ │ ├── metadata_rule.png │ │ ├── os_profile_drawer.png │ │ ├── schedule_list.png │ │ ├── schedule_main.png │ │ ├── schedule_repeat.png │ │ ├── specifications.png │ │ ├── ssh-key-using-host.png │ │ ├── ssh_key_menu.png │ │ ├── success_maintenance_menu_region.png │ │ ├── update_available_emt_en.png │ │ ├── update_available_emt_hosts.png │ │ ├── update_done_ubuntu.png │ │ ├── update_profiles.png │ │ ├── update_progress_emt.png │ │ ├── update_status.png │ │ ├── update_status_host_name.png │ │ ├── update_updating_ubuntu.png │ │ ├── view_cluster_template.png │ │ ├── view_os_profile.png │ │ └── workload_view_vm-2.png │ ├── import_cluster_template.rst │ ├── index.rst │ ├── install_new_packages.rst │ ├── os_profile_drawer.png │ ├── region_site_telemetry.rst │ ├── set_default_cluster_template.rst │ ├── set_up_a_cluster_template.rst │ ├── view_cluster_template.rst │ ├── view_os_profile.png │ └── view_os_profiles.rst │ ├── concepts │ ├── cluster_usergroups.rst │ ├── images │ │ ├── cluster_usergroups.png │ │ ├── define_criteria.png │ │ └── os_selection.png │ ├── index.rst │ ├── metadata_example.rst │ └── nztp.rst │ ├── get_started_guide │ ├── images │ │ └── get_started.png │ └── index.rst │ ├── how_it_works │ ├── images │ │ └── how_it_works2.png │ └── index.rst │ ├── images │ └── os_selection.png │ ├── index.rst │ ├── intel_solutions │ └── index.rst │ ├── monitor_deployments │ ├── alerts_view.rst │ ├── grafana_content.rst │ ├── images │ │ ├── alerts │ │ │ ├── EO-alert-definitions.png │ │ │ ├── EO-alert-details.png │ │ │ ├── EO-alert-list.png │ │ │ └── EO-email-config.png │ │ ├── audit_logs.png │ │ ├── console_access.png │ │ ├── delete_deploy.png │ │ ├── deploy_status1.png │ │ ├── edgenode_host_agentlogs.png │ │ ├── edgenode_host_healthchecklogs.png │ │ ├── edgenode_host_viewlogs.png │ │ ├── en_cluster_container_app.png │ │ ├── en_cluster_dashboard.png │ │ ├── en_cluster_pod_dashboard.png │ │ ├── en_cluster_vm_app.png │ │ ├── en_container_app_logs.png │ │ ├── en_host_dashboard.png │ │ ├── en_viewcluster_link.png │ │ ├── filter_metadata.png │ │ ├── grafana_signin.png │ │ ├── host_status.png │ │ ├── host_status1.png │ │ ├── orchestrator_cluster_dashboard.png │ │ ├── orchestrator_node_details.png │ │ ├── orchestrator_pod_details.png │ │ ├── orchestrator_pod_logs.png │ │ ├── provisioning_time.png │ │ ├── remote_desktop.png │ │ ├── upgrade_deploy1.png │ │ ├── upgrade_deploy2.png │ │ ├── view_deploymentdetails.png │ │ └── view_metrics.png │ ├── index.rst │ ├── kpi.rst │ ├── orchestrator_observability.rst │ └── status_deployment.rst │ ├── package_software │ ├── access_deploy.rst │ ├── add_a_deploy_pkg_profile.rst │ ├── add_applications.rst │ ├── add_deploy_pack.rst │ ├── add_registry.rst │ ├── app_details.rst │ ├── app_profile.rst │ ├── applications.rst │ ├── clone_applications.rst │ ├── delete_application.rst │ ├── delete_deploy_pack.rst │ ├── deploy_pack_details.rst │ ├── deploy_packages.rst │ ├── deployment_delete.rst │ ├── deployment_details.rst │ ├── deployment_edit.rst │ ├── deployment_upgrade.rst │ ├── deployments.rst │ ├── edit_application.rst │ ├── edit_deploy_pack.rst │ ├── edit_registry.rst │ ├── extension_package.rst │ ├── extensions │ │ ├── deploy_extension_package.rst │ │ ├── intel_gpu_package.rst │ │ ├── kubernetes_dashboard.rst │ │ ├── load_balancer.rst │ │ ├── sriov_package.rst │ │ ├── trusted_compute_package.rst │ │ ├── usb_package.rst │ │ └── virtualization_package.rst │ ├── image_pull_secret.rst │ ├── images │ │ ├── add_applications.png │ │ ├── add_deployment_profile.png │ │ ├── add_profile.png │ │ ├── add_profile_package.png │ │ ├── add_registry.png │ │ ├── add_site.png │ │ ├── application_details.png │ │ ├── application_page0.png │ │ ├── application_page1.png │ │ ├── application_registry.png │ │ ├── auto_deploy.png │ │ ├── clone_deploypack_new.png │ │ ├── console_access.png │ │ ├── create_deploy_pack.png │ │ ├── delete_applications.png │ │ ├── delete_deploy.png │ │ ├── delete_deploymentpack.png │ │ ├── delete_host.png │ │ ├── deploy_pack_details.png │ │ ├── deploy_status1.png │ │ ├── deployment-package-relationships.png │ │ ├── deployment_detailsnew.png │ │ ├── deployment_pack_extensions.png │ │ ├── deployment_pack_home.png │ │ ├── deployments_main.png │ │ ├── edit_app4.png │ │ ├── edit_app6.png │ │ ├── edit_deploy1.png │ │ ├── edit_deploy2.png │ │ ├── edit_deploypackage.png │ │ ├── edit_registry.png │ │ ├── endpoint-view-1.png │ │ ├── import_deploy.png │ │ ├── interconnect-arch.png │ │ ├── interconnect-select-network.png │ │ ├── manual_deployment.png │ │ ├── override_values.png │ │ ├── param_template.png │ │ ├── quick_start │ │ │ ├── app-details.png │ │ │ ├── app-profile.png │ │ │ ├── app-running.png │ │ │ ├── app-source.png │ │ │ ├── cli-secret.png │ │ │ ├── cluster-view.png │ │ │ ├── deploy-info.png │ │ │ ├── manual-deployment.png │ │ │ ├── nginx-welcome.png │ │ │ ├── select-applications.png │ │ │ ├── select-deploy.png │ │ │ └── user-profile.png │ │ ├── remote_desktop.png │ │ ├── set_up_deploy.png │ │ ├── upgrade_deploy1.png │ │ ├── upgrade_deploy2.png │ │ ├── workload_view_pod-1.png │ │ ├── workload_view_pod-2.png │ │ └── workload_view_vm-2.png │ ├── import_deployment.rst │ ├── index.rst │ ├── interconnect.rst │ ├── package_create_helm.rst │ ├── param_template.rst │ ├── push_registry.rst │ ├── quick_start_guide.rst │ ├── registry.rst │ ├── setup_deploy.rst │ └── vm_actions.rst │ ├── set_up_edge_infra │ ├── accessing_clusters.rst │ ├── cluster_details.rst │ ├── clusters_main.rst │ ├── configure_amt_asus.rst │ ├── create_clusters.rst │ ├── deauthorize_host.rst │ ├── delete_clusters.rst │ ├── delete_host.rst │ ├── edge_node_onboard.rst │ ├── edge_node_onboard_asus_system.rst │ ├── edge_node_onboard_common.rst │ ├── edge_node_onboard_dell_server.rst │ ├── edge_node_onboard_lenovo.rst │ ├── edge_node_registration.rst │ ├── edit_clusters.rst │ ├── edit_host.rst │ ├── images │ │ ├── add-db.png │ │ ├── add_region.png │ │ ├── add_site.png │ │ ├── add_site_button.png │ │ ├── add_subregion.png │ │ ├── advanced_settings.png │ │ ├── amt_bios_disable.png │ │ ├── amt_bios_menu.png │ │ ├── boot-option.png │ │ ├── clear-tpm.png │ │ ├── cluster_details1.png │ │ ├── cluster_details2.png │ │ ├── cluster_list_new.png │ │ ├── cluster_list_new1.png │ │ ├── configure_host_labels.png │ │ ├── confirm_host_deauthorization.png │ │ ├── create_cluster.png │ │ ├── create_cluster_host.png │ │ ├── deauthorize_host.png │ │ ├── default_cluster.png │ │ ├── delete_cluster.png │ │ ├── delete_host.png │ │ ├── delete_host_details.png │ │ ├── delete_region.png │ │ ├── deployment_metadata.png │ │ ├── devices.png │ │ ├── disable_unwanted_boot.png │ │ ├── download-template.png │ │ ├── downloadkubeconfig.png │ │ ├── edit_cluster.png │ │ ├── edit_host.png │ │ ├── edit_region.png │ │ ├── edit_site_button.png │ │ ├── filter_deauthorized_hosts.png │ │ ├── fixed_bootorder_settings.png │ │ ├── host_details.png │ │ ├── host_label.png │ │ ├── host_main.png │ │ ├── httpv4-enabled.png │ │ ├── httpv4v6-enabled.png │ │ ├── instances.png │ │ ├── io_devices.png │ │ ├── loca-devices-complete.png │ │ ├── loca-site.png │ │ ├── locations_homepage.png │ │ ├── onboard_host_action.png │ │ ├── onboarded_hosts.png │ │ ├── onboarded_hosts_details2.png │ │ ├── provision_host_action.png │ │ ├── provision_host_dropdown_menu.png │ │ ├── provision_host_labels.png │ │ ├── provision_host_status_menu.png │ │ ├── provision_os_profile.png │ │ ├── provision_os_public_ssh_key.png │ │ ├── provision_site.png │ │ ├── provisioned_hosts.png │ │ ├── region_detail.png │ │ ├── register_host.png │ │ ├── register_host_automatic.png │ │ ├── register_host_automatic_provision.png │ │ ├── register_host_details.png │ │ ├── register_host_success.png │ │ ├── register_host_success_automatic_provision.png │ │ ├── registered_host_status_menu.png │ │ ├── registered_hosts.png │ │ ├── resources.png │ │ ├── secure-boot.png │ │ ├── site_info_pane.png │ │ ├── site_info_via_name.png │ │ ├── specifications.png │ │ ├── start-options.png │ │ ├── status_details.png │ │ ├── template.png │ │ ├── template_end.png │ │ ├── tls.png │ │ ├── upload.png │ │ ├── usb-boot.png │ │ └── vmedia.png │ ├── index.rst │ ├── location │ │ ├── add_region.rst │ │ ├── add_site.rst │ │ ├── delete_region.rst │ │ ├── delete_site.rst │ │ ├── site_details.rst │ │ └── view_region_detail.rst │ ├── location_main.rst │ ├── onboard_dell │ │ ├── https_assisted_boot.rst │ │ ├── prepare_idrac.rst │ │ ├── prerequisites.rst │ │ ├── racadm_on_linux.rst │ │ ├── racadm_on_windows.rst │ │ └── usb_assisted_boot.rst │ ├── onboard_host.rst │ ├── onboard_host_details.rst │ ├── onboard_lenovo │ │ ├── https_assisted_boot.rst │ │ ├── loca_assisted_boot.rst │ │ ├── prerequisites.rst │ │ ├── setup_loca.rst │ │ └── usb_assisted_boot.rst │ ├── onboarded_hosts.rst │ ├── provision_host.rst │ ├── provisioned_host_details.rst │ ├── provisioned_hosts_main.rst │ └── registered_hosts.rst │ └── troubleshooting │ ├── deauthorize.rst │ ├── deploy_issue.rst │ ├── edge_node_onboard_troubleshooting.rst │ ├── en_recover.rst │ ├── hard_disk_boot.rst │ ├── images │ ├── argocd-restart-querier.png │ ├── boot_entry_selection.png │ ├── clear_tpm_bios.png │ ├── deployment-host-metadata-ztp-1.png │ ├── deployment-host-metadata-ztp-2.png │ ├── deployment-host-metadata-ztp-3.png │ ├── deployment-host-metadata-ztp-4.png │ ├── deployment-host-metadata-ztp-6.png │ ├── deployment_error.png │ ├── grafana-panel-error.png │ ├── onboarding_error.png │ ├── os_boot_failed.png │ ├── provisioning_error.png │ ├── register_host_already_existing.png │ ├── registered_host_connection_error.png │ ├── registered_host_view_error.png │ └── registered_hosts.png │ ├── index.rst │ ├── management_issue.rst │ ├── o11y_grafana_mimir.rst │ ├── operate_issues.rst │ └── provision_issue.rst ├── generate ├── README.rst ├── role_docs.py ├── sources │ ├── iam_details.yaml │ ├── keycloak-tenant-controller.tpl │ └── platform-keycloak.yaml └── templates │ └── shared_iam_groups.rst.j2 ├── requirements.txt ├── trivy-secret.yaml └── trivy.yaml /.gitattributes: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | # always save rst files in unix format, per doc8 5 | *.rst text eol=lf 6 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # CODEOWNERS for edge-manage-docs 2 | 3 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 4 | # SPDX-License-Identifier: Apache-2.0 5 | 6 | # docs for CODEOWNERS 7 | # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners 8 | 9 | # default owners - covers lint/config/build tooling in repo root 10 | * @achamuah @swpng @adreanneb @zdw @jouillet @andrea-campanella @ajaythakurintel @patricia-cahill 11 | 12 | # documentation content 13 | docs/ @achamuah @swpng @zdw @andrea-campanella @ajaythakurintel @patricia-cahill 14 | docs/developer_guide @adreanneb @achamuah @swpng @zdw @andrea-campanella @ajaythakurintel @patricia-cahill 15 | README.md @achamuah @swpng @adreanneb @zdw @andrea-campanella @ajaythakurintel @patricia-cahill 16 | 17 | # CI files 18 | .github/ @zdw @jouillet @andrea-campanella @ajaythakurintel @patricia-cahill 19 | 20 | # shared doc config 21 | docconf/ @zdw @jouillet @andrea-campanella @ajaythakurintel @patricia-cahill 22 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # PR Description 2 | 3 | Describe the purpose of this pull request. 4 | 5 | ## Changes 6 | 7 | List the changes you have made. 8 | 9 | ## Additional Information 10 | 11 | Include any additional information, such as how to test your changes. 12 | 13 | ## Checklist 14 | 15 | - [ ] Tests passed 16 | - [ ] Documentation updated 17 | -------------------------------------------------------------------------------- /.github/SECURITY.md: -------------------------------------------------------------------------------- 1 | # SECURITY POLICY 2 | 3 | Intel is committed to rapidly addressing security vulnerabilities affecting our 4 | customers and providing clear guidance on the solution, impact, severity and 5 | mitigation. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | Please report any security vulnerabilities in this project utilizing the 10 | guidelines 11 | [here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html). 12 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | --- 5 | version: 2 6 | updates: 7 | - package-ecosystem: "github-actions" 8 | directory: "/" 9 | schedule: 10 | interval: daily 11 | open-pull-requests-limit: 10 12 | commit-message: 13 | prefix: "[gha] " 14 | -------------------------------------------------------------------------------- /.github/workflows/labeler.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 3 | # SPDX-License-Identifier: Apache-2.0 4 | 5 | name: labeler 6 | 7 | on: # yamllint disable-line rule:truthy 8 | pull_request: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | jobs: 15 | label: 16 | permissions: 17 | contents: read 18 | pull-requests: write 19 | runs-on: ubuntu-latest 20 | steps: 21 | - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5 22 | -------------------------------------------------------------------------------- /.github/workflows/publish-docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 3 | # SPDX-License-Identifier: Apache-2.0 4 | 5 | name: Publish Documentation 6 | on: # yamllint disable-line rule:truthy 7 | workflow_dispatch: 8 | 9 | 10 | jobs: 11 | publish-documentation: 12 | permissions: 13 | contents: read # needed for actions/checkout 14 | pull-requests: read # needed for gh pr list 15 | issues: write # needed to post PR comment 16 | uses: open-edge-platform/orch-ci/.github/workflows/publish-documentation.yml@d475e84f8b0b7bff118f0e8f56712390ef8d2828 # yamllint disable-line rule:line-length 17 | with: 18 | simple_mode: false 19 | branch_pattern: '^(main|release-[0-9]+\.[0-9]+*)$' 20 | secrets: 21 | SYS_ORCH_GITHUB: ${{ secrets.SYS_ORCH_GITHUB }} 22 | DOC_AWS_ACCESS_KEY_ID: ${{ secrets.DOC_AWS_ACCESS_KEY_ID }} 23 | DOC_AWS_SECRET_ACCESS_KEY: ${{ secrets.DOC_AWS_SECRET_ACCESS_KEY }} 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | # editor temp files 5 | *~ 6 | *.swp 7 | *.swo 8 | 9 | # build directories 10 | */_build 11 | 12 | # python temp files 13 | docconf/*.egg-info 14 | docconf/build 15 | 16 | # ci/output dirs 17 | ci/ 18 | out/ 19 | gitleaks* 20 | 21 | # virtualenv 22 | venv* 23 | 24 | #IDEs 25 | .vscode 26 | .idea/ 27 | .DS_Store 28 | -------------------------------------------------------------------------------- /REUSE.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | version = 1 5 | 6 | [[annotations]] 7 | path = [ 8 | ".github/**", 9 | ".gitignore", 10 | 11 | "VERSION", 12 | "README.md", 13 | "SECURITY.md", 14 | 15 | "dict.txt", 16 | 17 | "docs/**.csv", 18 | "docs/**.jpeg", 19 | "docs/**.json", 20 | "docs/**.md", 21 | "docs/**.png", 22 | "docs/**.rst", 23 | "docs/**.svg", 24 | "docs/api/openapi/*.yaml", 25 | "docs/substitutions.txt", 26 | ] 27 | 28 | SPDX-FileCopyrightText = "2025 Intel Corporation" 29 | SPDX-License-Identifier = "Apache-2.0" 30 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation. 3 | 4 | ## Reporting a Vulnerability 5 | Please report any security vulnerabilities in this project utilizing the guidelines [here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html). -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 3.1.0-dev 2 | -------------------------------------------------------------------------------- /docconf/docconf/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docconf/docconf/__init__.py -------------------------------------------------------------------------------- /docconf/pyproject.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | [project] 5 | name = "docconf" 6 | version = "0.1.0" 7 | description = "Common configuration for documentation" 8 | requires-python = ">=3.10" 9 | classifiers = [ 10 | "Programming Language :: Python :: 3", 11 | "Operating System :: OS Independent", 12 | "License :: OSI Approved :: Apache 2.0", 13 | ] 14 | -------------------------------------------------------------------------------- /docs/_static/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/_static/one-edge-platform-login-title.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/_static/one-edge-platform-login-title.png -------------------------------------------------------------------------------- /docs/api/alerting_monitor.rst: -------------------------------------------------------------------------------- 1 | Alerting Monitor API 2 | ==================== 3 | 4 | Alerting Monitor is an Observability Management Service that exposes API for 5 | configuring alerts. 6 | 7 | `Download the Alerting Monitor API in OpenAPI YAML format 8 | <../_static/amc-o11y-alerting-monitor-openapi.yaml>`_ 9 | 10 | .. openapi:: openapi/amc-o11y-alerting-monitor-openapi.yaml 11 | -------------------------------------------------------------------------------- /docs/api/app_catalog.rst: -------------------------------------------------------------------------------- 1 | Application Catalog API 2 | ======================= 3 | 4 | Primary API 5 | ----------- 6 | 7 | `Download the App Catalog API in OpenAPI YAML format 8 | <../_static/amc-app-orch-catalog-openapi.yaml>`_ 9 | 10 | .. openapi:: openapi/amc-app-orch-catalog-openapi.yaml 11 | 12 | Utilities API 13 | ------------- 14 | 15 | `Download the App Catalog Utilities API in OpenAPI YAML format 16 | <../_static/amc-app-orch-catalog-utilities-openapi.yaml>`_ 17 | 18 | .. openapi:: openapi/amc-app-orch-catalog-utilities-openapi.yaml 19 | -------------------------------------------------------------------------------- /docs/api/app_deployment_manager.rst: -------------------------------------------------------------------------------- 1 | Application Deployment Manager API 2 | ================================== 3 | 4 | `Download the Application Deployment Manager API in OpenAPI YAML format 5 | <../_static/amc-app-orch-deployment-app-deployment-manager-openapi.yaml>`_ 6 | 7 | .. openapi:: openapi/amc-app-orch-deployment-app-deployment-manager-openapi.yaml 8 | -------------------------------------------------------------------------------- /docs/api/app_resource_manager.rst: -------------------------------------------------------------------------------- 1 | Application Resource Manager API 2 | ================================ 3 | 4 | `Download the Application Resource Manager API in OpenAPI YAML format 5 | <../_static/amc-app-orch-deployment-app-resource-manager-openapi.yaml>`_ 6 | 7 | .. openapi:: openapi/amc-app-orch-deployment-app-resource-manager-openapi.yaml 8 | -------------------------------------------------------------------------------- /docs/api/cluster_manager.rst: -------------------------------------------------------------------------------- 1 | Cluster Manager API 2 | =================== 3 | 4 | `Download the Cluster Manager API in OpenAPI YAML format 5 | <../_static/amc-cluster-manager-openapi.yaml>`_ 6 | 7 | .. openapi:: openapi/amc-cluster-manager-openapi.yaml 8 | -------------------------------------------------------------------------------- /docs/api/index.rst: -------------------------------------------------------------------------------- 1 | APIs 2 | ==== 3 | 4 | The following APIs are available for the Edge Orchestrator: 5 | 6 | .. toctree:: 7 | 8 | alerting_monitor 9 | app_catalog 10 | app_deployment_manager 11 | app_resource_manager 12 | cluster_manager 13 | edge_infra_manager 14 | metadata 15 | tenancy 16 | -------------------------------------------------------------------------------- /docs/api/metadata.rst: -------------------------------------------------------------------------------- 1 | Metadata Broker API 2 | =================== 3 | 4 | `Download the Metadata Broker in OpenAPI YAML format 5 | <../_static/amc-orch-metadata-broker-openapi.yaml>`_ 6 | 7 | .. openapi:: openapi/amc-orch-metadata-broker-openapi.yaml 8 | -------------------------------------------------------------------------------- /docs/api/tenancy.rst: -------------------------------------------------------------------------------- 1 | Tenancy API 2 | =========== 3 | 4 | The Tenancy REST API provides for Organization, Project, and other 5 | tenant-specific data like Licensing. These APIs offer Create, Read, Update, 6 | Delete capabilities. 7 | 8 | Tenancy REST API are secured via certificates and credentials. 9 | 10 | `Download the Tenancy API in OpenAPI YAML format 11 | <../_static/orch-utils.tenancy-datamodel.openapi.yaml>`_ 12 | 13 | .. openapi:: openapi/orch-utils.tenancy-datamodel.openapi.yaml 14 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_advanced/cloud_edge_node.rst: -------------------------------------------------------------------------------- 1 | Edge Orchestrator Configuration for Edge Node 2 | ################################################ 3 | 4 | Edge Orchestrator uses default settings for installation. If your network or services 5 | require specific settings, see the information below. 6 | 7 | - netIP - Set by default to dynamic. This is required to prevent communication problems 8 | with the Kubernetes cluster. This value can be set to static, but it is not recommended. 9 | - firewallCfgAllow - Set the environment firewall to Allow. Retain the existing ports, 10 | ipVer and protocol configurations. Use a blank value (“”) or remove the elements if not 11 | required for firewall configuration. 12 | - ntpServer - Update to the NTP server used by the environment. Reachable by the network. 13 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_advanced/cloud_manual_bp.rst: -------------------------------------------------------------------------------- 1 | Manual installation best practices 2 | ################################## 3 | 4 | #. Choose an S3 bucket name for the installation and make a note of it. 5 | #. Be consistent with naming files. Make a note of the names, bucket names, paths, and regions used during setup. 6 | #. Start with a new bucket for installation. Don't reuse an existing bucket. 7 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_advanced/cloud_manual_dns.rst: -------------------------------------------------------------------------------- 1 | Begin Manual Installation 2 | ######################### 3 | 4 | Verify environment readiness 5 | ---------------------------- 6 | 7 | Precheck ensures that your AWS cloud credentials are in place and not expired. It also checks the versions of software on the local PC for compatibility. 8 | 9 | #. In a terminal, go to the ``pod-configs`` installation root directory. 10 | This is the directory where the infrastructure install package was extracted. 11 | #. Run the precheck. 12 | 13 | .. code-block:: bash 14 | 15 | make precheck 16 | 17 | If validation is successful, it shows the following message. 18 | 19 | .. code-block:: text 20 | 21 | Ready to provision the infrastructure. 22 | 23 | If validation fails, precheck provides an error log. Install any missing packages or update the AWS credentials, and run ``make precheck`` again. 24 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_appendix/images/os_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/cloud_deployment/cloud_appendix/images/os_selection.png -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_appendix/index.rst: -------------------------------------------------------------------------------- 1 | Appendix 2 | ========= 3 | 4 | This section gives you supplementary information and technical details for deploying Edge Orchestrator. 5 | 6 | - :doc:`/deployment_guide/cloud_deployment/cloud_appendix/cloud_cluster_autoscaling` 7 | - :doc:`/deployment_guide/cloud_deployment/cloud_appendix/cloud_cluster_definition` 8 | - :doc:`/deployment_guide/cloud_deployment/cloud_appendix/cloud_aws_iam_permissions` 9 | - :doc:`/shared/shared_os_profile` 10 | 11 | .. toctree:: 12 | :hidden: 13 | 14 | cloud_cluster_autoscaling 15 | cloud_cluster_definition 16 | cloud_aws_iam_permissions 17 | ../../../shared/shared_os_profile 18 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_examples/cloud_account.rst: -------------------------------------------------------------------------------- 1 | Account module examples 2 | ========================= 3 | 4 | Each module type uses both ``backend.tf`` and ``variable.tfvar`` files. 5 | 6 | Account file examples 7 | --------------------- 8 | 9 | .. code-block:: terraform 10 | :caption: variable.tfvar file example 11 | 12 | variable "codecommit_user_ssh_key" { 13 | type = string 14 | default = "" 15 | } 16 | 17 | variable "feature_flags" { 18 | type = map(bool) 19 | default = { 20 | codecommit = false 21 | iam_roles = true 22 | } 23 | } 24 | 25 | variable "region" { 26 | type = string 27 | default = "" 28 | } 29 | 30 | .. code-block:: terraform 31 | :caption: backend.tf file example 32 | 33 | region="us-west-2" 34 | bucket="example_bucket" 35 | key="us-west-2/account/environment_name" 36 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_examples/cloud_buckets.rst: -------------------------------------------------------------------------------- 1 | Bucket module examples 2 | ====================== 3 | 4 | Each module type uses both ``backend.tf`` and ``variable.tfvar`` files. 5 | 6 | .. code-block:: terraform 7 | :caption: backend.tf file example 8 | 9 | path="the path to store tfstate" 10 | 11 | .. code-block:: terraform 12 | :caption: variable.tfvar example 13 | 14 | bucket = "bucket_name" 15 | region = "us-west-2" 16 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_examples/cloud_route53.rst: -------------------------------------------------------------------------------- 1 | Orch-Route53 Module Examples 2 | =============================== 3 | 4 | Each module type uses both ``backend.tf`` and ``variable.tfvar`` files. 5 | 6 | .. code-block:: terraform 7 | :caption: backend.tf example 8 | 9 | region="us-west-2" 10 | bucket="example-bucket" 11 | key="use-west-2/external/orch-route53/my-env" 12 | 13 | .. code-block:: terraform 14 | :caption: variable.tfvar example 15 | 16 | lb_created = false 17 | orch_name = "" 18 | parent_zone = "" 19 | vpc_id = "" 20 | vpc_region = "us-west-2" 21 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_get_started/cloud_certs.rst: -------------------------------------------------------------------------------- 1 | Certificate Requirements 2 | ========================================== 3 | 4 | To install and configure Edge Orchestrator, generate or use an existing SSL 5 | certificate. 6 | 7 | The SSL certificate requires multiple subdomains for a single domain. 8 | 9 | Edge Orchestrator requires the following information about the SSL certificate: 10 | 11 | * Full certificate chain for root domain 12 | * Private SSL key 13 | * CA certificate bundle 14 | 15 | Alternatively, the Edge Orchestrator supports automated certificate 16 | management with certs issued by Let's Encrypt\*, eliminating the need for 17 | manual certificate provisioning and maintenance. This feature provides a 18 | streamlined and convenient approach for users who favor automation. 19 | 20 | .. note:: 21 | Certificates issued by Let's Encrypt\* are valid for 90 days. The Edge 22 | Orchestrator is designed to handle the renewal of this certificate seamlessly prior to its expiration. 23 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/cloud_how_to/index.rst: -------------------------------------------------------------------------------- 1 | How To 2 | ===================================== 3 | 4 | - :doc:`/shared/shared_ht_iam_ext` 5 | - :doc:`/shared/shared_ht_iam_groups` 6 | - :doc:`/shared/shared_iam_groups` 7 | - :doc:`/deployment_guide/cloud_deployment/cloud_how_to/cloud_certificates` 8 | - :doc:`/deployment_guide/cloud_deployment/cloud_how_to/cloud_cc_cred_refresh` 9 | - :doc:`/deployment_guide/cloud_deployment/cloud_how_to/cloud_uninstall` 10 | - :doc:`/deployment_guide/cloud_deployment/cloud_how_to/cloud_scale_orch` 11 | 12 | .. toctree:: 13 | :hidden: 14 | 15 | ../../../shared/shared_ht_iam_ext 16 | ../../../shared/shared_ht_iam_groups 17 | ../../../shared/shared_iam_groups 18 | cloud_certificates 19 | cloud_cc_cred_refresh 20 | cloud_uninstall 21 | cloud_scale_orch 22 | -------------------------------------------------------------------------------- /docs/deployment_guide/cloud_deployment/index.rst: -------------------------------------------------------------------------------- 1 | .. _cloud_index: 2 | 3 | Edge Orchestrator Deployment Guide for AWS\* Cloud 4 | ================================================== 5 | 6 | - :doc:`/deployment_guide/cloud_deployment/cloud_get_started/index` 7 | - :doc:`/deployment_guide/cloud_deployment/cloud_get_started/system_requirements_aws_orch` 8 | - :doc:`/deployment_guide/cloud_deployment/cloud_get_started/cloud_certs` 9 | - :doc:`/deployment_guide/cloud_deployment/cloud_get_started/cloud_start_installer` 10 | - :doc:`/deployment_guide/cloud_deployment/cloud_get_started/cloud_orchestrator_install` 11 | - :doc:`/shared/shared_gs_iam` 12 | - :doc:`/shared/shared_mt_overview` 13 | - :doc:`/shared/shared_next_steps` 14 | 15 | .. toctree:: 16 | :hidden: 17 | 18 | cloud_get_started/index 19 | cloud_how_to/index 20 | cloud_examples/index 21 | cloud_advanced/index 22 | cloud_troubleshooting/index 23 | cloud_appendix/index 24 | 25 | -------------------------------------------------------------------------------- /docs/deployment_guide/index.rst: -------------------------------------------------------------------------------- 1 | Deployment Guide 2 | ================ 3 | 4 | You have the flexibility to deploy our |software_prod_name|\ using either 5 | Amazon Web Services\* (AWS\*) cloud or on-premises infrastructure, depending on 6 | your specific needs and preferences. 7 | 8 | To get started, refer to the following sections for detailed instructions and 9 | guidance tailored to each deployment option. 10 | 11 | * :doc:`cloud_deployment/index` 12 | * :doc:`on_prem_deployment/index` 13 | 14 | .. toctree:: 15 | :hidden: 16 | 17 | cloud_deployment/index 18 | on_prem_deployment/index 19 | -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config-with-corporate-proxy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config-with-corporate-proxy.png -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config-with-squid-proxy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config-with-squid-proxy.png -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/on_prem_deployment/images/on-prem-install-topology-config.png -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/images/on-prem-loca-install-topology-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/on_prem_deployment/images/on-prem-loca-install-topology-config.png -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/images/os_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/deployment_guide/on_prem_deployment/images/os_selection.png -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/index.rst: -------------------------------------------------------------------------------- 1 | Edge Orchestrator On-Premises Installation Guide 2 | ================================================ 3 | 4 | 5 | - :doc:`/deployment_guide/on_prem_deployment/on_prem_get_started/index` 6 | - :doc:`/deployment_guide/on_prem_deployment/on_prem_get_started/system_requirements_on_prem_orch` 7 | - :doc:`/deployment_guide/on_prem_deployment/on_prem_get_started/on_prem_certs` 8 | - :doc:`/shared/shared_gs_preinstall` 9 | - :doc:`/deployment_guide/on_prem_deployment/on_prem_get_started/on_prem_install` 10 | - :doc:`/shared/shared_gs_iam` 11 | - :doc:`/shared/shared_mt_overview` 12 | - :doc:`/shared/shared_next_steps` 13 | 14 | 15 | 16 | .. toctree:: 17 | :hidden: 18 | 19 | 20 | on_prem_get_started/index 21 | on_prem_how_to/index 22 | on_prem_troubleshooting/index 23 | on_prem_appendix/index 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/on_prem_appendix/index.rst: -------------------------------------------------------------------------------- 1 | Appendix 2 | =========== 3 | This section gives you supplementary information and technical details for deploying Edge Orchestrator. 4 | 5 | - :doc:`/shared/shared_os_profile` 6 | 7 | .. toctree:: 8 | :hidden: 9 | 10 | ../../../shared/shared_os_profile 11 | -------------------------------------------------------------------------------- /docs/deployment_guide/on_prem_deployment/on_prem_how_to/on_prem_uninstall.rst: -------------------------------------------------------------------------------- 1 | Uninstall Edge Orchestrator Infrastructure 2 | ====================================================== 3 | 4 | Uninstall the Edge Orchestrator environment and installer packages. 5 | 6 | Uninstall Edge Orchestrator 7 | ---------------------------------------------- 8 | 9 | #. Navigate to the directory to which ``uninstall_onprem.sh`` script was downloaded. 10 | #. Run the script. 11 | 12 | .. code-block:: shell 13 | 14 | ./uninstall_onprem.sh 15 | 16 | The uninstall script will: 17 | 18 | * Remove individual installation packages. 19 | * Individual installation packages will uninstall components as part of removal. 20 | -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/agents_stack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/agents_stack.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/caddy-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/caddy-architecture.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/eim_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/eim_arch.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/ena-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/ena-architecture.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/na-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/na-system.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/poa-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/poa-system.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/pua-jwt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/pua-jwt.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/images/pua-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/agents/arch/images/pua-system.png -------------------------------------------------------------------------------- /docs/developer_guide/agents/arch/index.rst: -------------------------------------------------------------------------------- 1 | Architecture 2 | ============ 3 | 4 | `Edge Node Agents `_ are a collection of OS-level agents that make up an Edge Node. 5 | 6 | .. toctree:: 7 | :hidden: 8 | :maxdepth: 3 9 | 10 | hl_architecture 11 | cluster 12 | edge_node 13 | hardware_discovery 14 | platform_observability 15 | platform_telemetry 16 | platform_update 17 | 18 | -------------------------------------------------------------------------------- /docs/developer_guide/agents/index.rst: -------------------------------------------------------------------------------- 1 | Edge Node Agents 2 | ================ 3 | 4 | `Edge Node Agents `_ are a collection of OS-level agents that make up an Edge Node. 5 | 6 | .. figure:: ./arch/images/agents_stack.png 7 | :alt: High-Level functional domains of Edge Node Agents 8 | 9 | Edge Node Agents are deployed as system daemons during the provisioning of the 10 | Edge Node. 11 | 12 | Each Edge Node Agent is packaged and installed according to the requirements of 13 | the OS it is running on. In the case of mutable OSes, they are dynamically downloaded and 14 | installed as `.deb` packages. In the case of immutable OSes, they are already part of 15 | the OS distribution. 16 | 17 | .. toctree:: 18 | :hidden: 19 | :maxdepth: 1 20 | 21 | arch/index 22 | tutorials/index 23 | -------------------------------------------------------------------------------- /docs/developer_guide/agents/tutorials/developing/index.rst: -------------------------------------------------------------------------------- 1 | Contributing to Edge Node Agents 2 | ================================ 3 | 4 | This tutorial guides you through the process of contributing changes to Edge Node Agents. 5 | 6 | .. toctree:: 7 | :maxdepth: 3 8 | 9 | developing 10 | -------------------------------------------------------------------------------- /docs/developer_guide/agents/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | Tutorials and Examples 2 | ====================== 3 | 4 | The Edge Node Agents tutorials and examples are designed to help you understand how to 5 | extend Edge Node Agents software capabilities or create new ones. 6 | 7 | Whether you are new to Edge Node Agents or an experienced user, these 8 | tutorials and examples will help you get the most out of the Edge Node 9 | Agents software. 10 | 11 | .. toctree:: 12 | :hidden: 13 | :maxdepth: 1 14 | 15 | developing/index 16 | -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/deployment.rst: -------------------------------------------------------------------------------- 1 | Deployment 2 | ========== 3 | 4 | The Application Orchestrator is deployed as a set of microservices in a 5 | Kubernetes\* cluster. In the overall scope of the |software_prod_name| 6 | installation, the microservices are deployed by the Argo\* CD tool, which is a GitOps 7 | continuous delivery tool that ensures the platform is brought up quickly and 8 | reliably. 9 | -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/images/app-orch-data-model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/arch/images/app-orch-data-model.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/images/architecture-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/arch/images/architecture-diagram.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/images/import_adm_grafana_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/arch/images/import_adm_grafana_dashboard.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/images/view_adm_grafana_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/arch/images/view_adm_grafana_dashboard.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/arch/persona_interaction.rst: -------------------------------------------------------------------------------- 1 | Persona Interaction 2 | =================== 3 | 4 | The following personas interact with Application Orchestration: 5 | 6 | Application Developer 7 | --------------------- 8 | 9 | Creates and Uploads individual microservices and/or applications to the 10 | Application Catalog 11 | 12 | Independent Software Vendor (ISV) 13 | --------------------------------- 14 | 15 | Assembles individual software components to create a solution (“Deployment 16 | Package”) that may be deployed at an edge. 17 | 18 | DevOps / IT / OT 19 | ---------------- 20 | 21 | Deploys Deployment Packages onto edge sites via policies and manages the 22 | lifecycle of deployed applications. Observes the performance of edge nodes 23 | and repairs edge sites that may be damaged. 24 | 25 | SRE / Intel Support 26 | ------------------- 27 | 28 | Proactively and reactively addresses problems with Open Edge Platform 29 | components. 30 | -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/deploying-applications/index.rst: -------------------------------------------------------------------------------- 1 | Deploy Applications 2 | =================== 3 | 4 | As outlined in the Developer Workflow :doc:`/developer_guide/application_developer_workflow/deploying-applications/index`, 5 | you can now deploy the Tutorial Server and the Tutorial Web UI. This requires a running |software_prod_name| instance, 6 | a multi-tenancy-project and cluster(s) configured on one or more Edge Nodes. The User Guide and Developer Guide have the 7 | details on how to do this. 8 | 9 | - :doc:`import-dp` 10 | - :doc:`pushing_charts_and_images` 11 | - :doc:`deploying` 12 | 13 | .. toctree:: 14 | :hidden: 15 | :maxdepth: 1 16 | 17 | import-dp 18 | pushing_charts_and_images 19 | deploying 20 | -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-2.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-3.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-tutorial-6.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-deploy-view.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-edit-application.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-edit-application.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-edit-profile-tutorial-server.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-edit-profile-tutorial-server.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-edit-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-edit-profile.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-app-imported.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-app-imported.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-app-service-proxy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-app-service-proxy.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-deployed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-deployed.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-design.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-design.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-dp-imported.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-dp-imported.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-oci-registry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-oci-registry.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-fail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-fail.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-helm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-helm.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-nginx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui-nginx.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/app_orch/tutorials/images/app-orch-tutorial-web-ui.png -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | Tutorials and Examples 2 | ====================== 3 | 4 | Developing, deploying and managing applications in |software_prod_name| is easy and intuitive. This section provides 5 | tutorials and examples to help you get started with |software_prod_name| Application Orchestration. 6 | 7 | This tutorial will follow the 6-step approach outlined in the :doc:`../../application_developer_workflow/index`. 8 | 9 | The User Guide :doc:`/user_guide/package_software/quick_start_guide` gives a simpler overview of just the 10 | steps needed to bundle and deploy an application using Application Orchestration. 11 | 12 | The code examples given in this section are available at ``_. 13 | 14 | .. toctree:: 15 | :hidden: 16 | :maxdepth: 3 17 | 18 | developing-applications/index 19 | packaging-applications/index 20 | deployment-helm/index 21 | deployment-packages/index 22 | deploying-applications/index 23 | accessing-applications/index 24 | -------------------------------------------------------------------------------- /docs/developer_guide/app_orch/tutorials/packaging-applications/index.rst: -------------------------------------------------------------------------------- 1 | Package Applications 2 | ==================== 3 | 4 | As outlined in the Developer Workflow :doc:`/developer_guide/application_developer_workflow/packaging-applications/index`, 5 | the next step is to package the application. 6 | 7 | This is done using the `Docker\* `_ **build** command to 8 | create a Docker (container) image that can be deployed to the Application Orchestration platform. 9 | 10 | .. toctree:: 11 | :hidden: 12 | :maxdepth: 1 13 | 14 | packaging-tutorial-server 15 | packaging-tutorial-web-ui 16 | -------------------------------------------------------------------------------- /docs/developer_guide/application_developer_workflow/accessing-applications/index.rst: -------------------------------------------------------------------------------- 1 | Accessing Applications 2 | ====================== 3 | 4 | Once your Application is deployed, you have a number of options for accessing 5 | it, depending on the type of Application, and the access methods configured. 6 | 7 | See :doc:`/user_guide/package_software/access_deploy` for more details on the 8 | Access Methods. 9 | -------------------------------------------------------------------------------- /docs/developer_guide/application_developer_workflow/images/deployment-package-relationships.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/application_developer_workflow/images/deployment-package-relationships.png -------------------------------------------------------------------------------- /docs/developer_guide/application_developer_workflow/images/helm-docker-oci-root-url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/application_developer_workflow/images/helm-docker-oci-root-url.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/deployment.rst: -------------------------------------------------------------------------------- 1 | Deployment 2 | ========== 3 | 4 | Edge Cluster Orchestrator is typically deployed as a set of microservices in a Kubernetes\* 5 | cluster and it is part of the Edge Orchestrator services of Open Edge Platform along with Edge 6 | Application Orchestrator and Edge Infrastructure Manager. It leverages the same set of 7 | services provided by the Orchestration Platform Services, UI, and Observability framework. 8 | 9 | In the overall scope of |software_prod_name| installation, the microservices are deployed 10 | by Argo\* CD, which is a GitOps continuous delivery tool that ensures the platform is brought 11 | up quickly and reliably. 12 | 13 | The Edge Cluster Orchestrator components can be deployed as standalone components for 14 | development and testing purposes. For more details, see the README documents stored in the 15 | Edge Cluster Orchestrator component repositories. 16 | -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-capi-provider-intel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-capi-provider-intel.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-cluster-connect-gateway.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-cluster-connect-gateway.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-day0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-day0.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-day1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-day1.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-day2-delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-day2-delete.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0-ecm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0-ecm.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/co-2.0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/co-2.0.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/images/stack-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/cluster_orch/arch/images/stack-diagram.png -------------------------------------------------------------------------------- /docs/developer_guide/cluster_orch/arch/workflows.rst: -------------------------------------------------------------------------------- 1 | Cluster Lifecycle Workflows 2 | =========================== 3 | 4 | Day 0 5 | ----- 6 | 7 | .. image:: images/co-2.0-day0.png 8 | :alt: Day0 Workflow 9 | 10 | Day 1 11 | ----- 12 | 13 | .. image:: images/co-2.0-day1.png 14 | :alt: Day0 Workflow 15 | 16 | Day 2: Delete 17 | ------------- 18 | 19 | .. image:: images/co-2.0-day2-delete.png 20 | :alt: Day0 Workflow 21 | 22 | Day 2: Upgrade 23 | -------------- 24 | 25 | Cluster upgrade is not supported yet. It will be added in future releases. 26 | 27 | -------------------------------------------------------------------------------- /docs/developer_guide/contributor_guide/images/submit-changes.drawio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/contributor_guide/images/submit-changes.drawio.png -------------------------------------------------------------------------------- /docs/developer_guide/contributor_guide/security.rst: -------------------------------------------------------------------------------- 1 | Security Policy 2 | =============== 3 | 4 | Intel is committed to rapidly addressing security vulnerabilities affecting our 5 | customers and providing clear guidance on the solution, impact, severity and 6 | mitigation. 7 | 8 | Reporting a Security Problem or Vulnerability 9 | --------------------------------------------- 10 | 11 | Please report any security vulnerabilities in this project utilizing the 12 | guidelines given at the `Intel Security Center 13 | `_ 14 | -------------------------------------------------------------------------------- /docs/developer_guide/images/edge_platform_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/images/edge_platform_arch.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/data_model.rst: -------------------------------------------------------------------------------- 1 | Data Model 2 | ========== 3 | Inventory is the state store and the only component that persists state in Edge Infrastructure Manager. In the component `repository `_ you can find more details and technical documentation about the Inventory component. 4 | 5 | The database schema is represented in this `ER Diagram `_. 6 | -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_arch.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_deployment.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_loca.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_loca.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_provisioning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_provisioning.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_provisioning_detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_provisioning_detail.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_provisioning_en_lifecycle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_provisioning_en_lifecycle.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/images/eim_stack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/arch/images/eim_stack.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/arch/index.rst: -------------------------------------------------------------------------------- 1 | Architecture 2 | ============ 3 | 4 | Edge Infrastructure Manager offers policy-based secure life cycle management 5 | of a fleet of edge nodes/devices at scale, spread across distributed locations 6 | allowing onboarding, provisioning, inventory management, upgrades and more. 7 | 8 | .. toctree:: 9 | :hidden: 10 | :maxdepth: 3 11 | 12 | background 13 | overview 14 | hl_architecture 15 | data_flow 16 | data_model 17 | provisioning 18 | extensibility 19 | deployment 20 | day2_flow 21 | security 22 | scalability 23 | multi_tenancy 24 | -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | Tutorials and Examples 2 | ====================== 3 | 4 | In this section, you will find tutorials and examples for Edge Infrastructure 5 | Manager. The tutorials and examples are designed to help you understand how to 6 | extend Edge Infrastructure Manager software capabilities. 7 | 8 | Whether you are new to Edge Infrastructure Manager or an experienced user, these 9 | tutorials and examples will help you get the most out of the Edge Infrastructure 10 | Manager software. 11 | 12 | .. toctree:: 13 | :hidden: 14 | :maxdepth: 1 15 | 16 | new_resource/index 17 | os_profiles/index 18 | upgrade/index 19 | -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/new_resource/index.rst: -------------------------------------------------------------------------------- 1 | Extending Infrastructure Manager APIs 2 | ========================================== 3 | 4 | This tutorial guides you through the process of adding a new resource to Edge 5 | Infrastructure Manager. 6 | 7 | The journey starts from Inventory where the abstractions are defined, then 8 | moves to the API where the resources are exposed and presented to the users. 9 | 10 | .. toctree:: 11 | :hidden: 12 | :maxdepth: 3 13 | 14 | inventory 15 | api 16 | multitenancy 17 | -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/os_profiles/index.rst: -------------------------------------------------------------------------------- 1 | Contributing OS Profiles 2 | ======================== 3 | 4 | This tutorial guides you through the process of contributing new OS profiles that will be deployed to Edge Orchestrator by default. 5 | 6 | .. toctree:: 7 | :hidden: 8 | :maxdepth: 3 9 | 10 | adding_os_profiles 11 | testing_custom_os_resource 12 | -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/upgrade/images/rollback-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/tutorials/upgrade/images/rollback-example.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/upgrade/images/rollback-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/infra_manager/tutorials/upgrade/images/rollback-tab.png -------------------------------------------------------------------------------- /docs/developer_guide/infra_manager/tutorials/upgrade/index.rst: -------------------------------------------------------------------------------- 1 | Upgrading Edge Orchestrator v3.0 2 | ================================ 3 | 4 | This tutorial guides you through upgrading Infrastructure Manager v3.0, verifying its functionality, and rolling back to the previous version if needed. 5 | 6 | .. toctree:: 7 | :hidden: 8 | :maxdepth: 3 9 | 10 | orch_upgrade 11 | -------------------------------------------------------------------------------- /docs/developer_guide/observability/arch/images/overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/observability/arch/images/overview.png -------------------------------------------------------------------------------- /docs/developer_guide/observability/arch/orchestrator/images/alerts-configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/observability/arch/orchestrator/images/alerts-configuration.png -------------------------------------------------------------------------------- /docs/developer_guide/observability/arch/orchestrator/images/reported-alerts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/observability/arch/orchestrator/images/reported-alerts.png -------------------------------------------------------------------------------- /docs/developer_guide/observability/index.rst: -------------------------------------------------------------------------------- 1 | Observability 2 | ============= 3 | 4 | Observability is a key aspect of |software_prod_name| that provides visibility 5 | into the health and performance of the system. This section provides a 6 | comprehensive view of |software_prod_name| observability platform and an 7 | overview of key components that help you monitor, analyze, and troubleshoot the 8 | Edge Nodes and |software_prod_name| itself. 9 | 10 | Development of observability features in |software_prod_name| is a complex task 11 | that requires understanding of |software_prod_name| architecture, 12 | observability stack components, and the data flow between them. This section 13 | provides detailed information on how to develop and contribute to the 14 | observability features in |software_prod_name|. 15 | 16 | Tutorials and examples are also provided here to help you understand how to use 17 | the Observability features in |software_prod_name|. 18 | 19 | .. toctree:: 20 | :hidden: 21 | :maxdepth: 1 22 | 23 | arch/index 24 | tutorials/index 25 | -------------------------------------------------------------------------------- /docs/developer_guide/observability/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | Tutorials and Examples 2 | ====================== 3 | 4 | In this section, you will find tutorials and examples that will help you 5 | understand how to use the Observability features in |software_prod_name|. 6 | 7 | .. toctree:: 8 | :maxdepth: 1 9 | 10 | development/email-notifications 11 | -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/images/argo-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/images/argo-architecture.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/images/argo-config-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/images/argo-config-flow.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/images/argo-config-flow2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/images/argo-config-flow2.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/images/high-level-network-architecture-cloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/images/high-level-network-architecture-cloud.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/index.rst: -------------------------------------------------------------------------------- 1 | Architecture 2 | ============ 3 | 4 | The Platform services provides all elements and deployment scripts 5 | necessary for setting up the Edge Orchestrator in both on-premise and cloud-based 6 | environments. Following you can find details on how Argo* CD is used and 7 | architecture for both cloud and on-premises environments. 8 | 9 | .. toctree:: 10 | :maxdepth: 1 11 | 12 | argocd 13 | cloud_orchestrator 14 | on_premise_orchestrator/index 15 | -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/deployment.rst: -------------------------------------------------------------------------------- 1 | Deployment 2 | ========== 3 | 4 | Edge Orchestrator is deployed on-premises using the installer bash script which will handle installation of the key components. The installer script can be found [here](https://github.com/open-edge-platform/edge-manageability-framework/blob/main/on-prem-installers/onprem/onprem_installer.sh): 5 | 6 | - onprem-config-installer 7 | - onprem-ke-installer 8 | - onprem-gitea-installer 9 | - onprem-argocd-installer 10 | - onprem-orch-installer 11 | -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/images/on-prem-high-level-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/on_premise_orchestrator/images/on-prem-high-level-architecture.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/images/onPrem-services-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/platform/arch/on_premise_orchestrator/images/onPrem-services-architecture.png -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/index.rst: -------------------------------------------------------------------------------- 1 | On-Premise Architecture 2 | ======================= 3 | 4 | Target Audience 5 | ~~~~~~~~~~~~~~~ 6 | 7 | The target audience for this guide includes developers, architects, and system administrators who are responsible for deploying and managing the On-Premise Edge Orchestrator. 8 | 9 | End users can refer to the User Guide for further information on how to deploy and use On-Premise Edge Orchestrator. 10 | 11 | Overview 12 | -------- 13 | 14 | On-Premise Edge Orchestrator is one of the methods of deployment for Edge Orchestrator. 15 | 16 | Architecture Diagram 17 | -------------------- 18 | 19 | .. figure:: ../../../images/edge_platform_arch.png 20 | :alt: High-level architecture of On-Premise Edge Orchestrator 21 | 22 | Figure 1: High-level architecture of On-Premise Edge Orchestrator 23 | 24 | 25 | .. toctree:: 26 | :hidden: 27 | :maxdepth: 3 28 | 29 | data_flow 30 | deployment 31 | extensibility 32 | key_components 33 | scalability 34 | security 35 | technology_stack 36 | -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/scalability.rst: -------------------------------------------------------------------------------- 1 | Scalability 2 | =========== 3 | 4 | On-Premise Edge Orchestrator is designed to be scalable to support large scale deployments. 5 | This section provides an overview of the scalability considerations, support strategies, 6 | and mechanisms used to achieve scalability. 7 | 8 | Scalability Support 9 | ~~~~~~~~~~~~~~~~~~~ 10 | 11 | On-Premise Edge Orchestrator supports scalability through the use of Kubernetes\* platform, 12 | which allows for the deployment of applications to be scaled as needed. 13 | 14 | Scalability Mechanisms 15 | ~~~~~~~~~~~~~~~~~~~~~~ 16 | 17 | On-Premise Edge Orchestrator allows for scalability in the same way that other 18 | Kubernetes applications do, using the underlying Kubernetes platform 19 | (through RKE2 in this particular instance), which allows for the applications 20 | deployed to be scaled as needed. 21 | -------------------------------------------------------------------------------- /docs/developer_guide/platform/arch/on_premise_orchestrator/technology_stack.rst: -------------------------------------------------------------------------------- 1 | Technology Stack 2 | ================ 3 | 4 | Implementation 5 | ~~~~~~~~~~~~~~ 6 | 7 | Edge Orchestrator on-premises uses `Go\* programming language `_ as the primary development language. 8 | -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/hook_os.rst: -------------------------------------------------------------------------------- 1 | =============== 2 | Hook OS Logs 3 | =============== 4 | 5 | Logs of all the running services are located in the `/var/log/` directory. 6 | 7 | Docker Logs 8 | =========== 9 | Use `docker` commands to access the tink worker/agent container and workflow 10 | action containers. 11 | 12 | - Use `docker logs tink-worker --follow` to watch the worker logs. 13 | -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/agent-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/agent-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/audit_logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/audit_logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/bridge-network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/bridge-network.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/cluster-obs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/cluster-obs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/connectAgent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/connectAgent.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/download_kubeconfig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/download_kubeconfig.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/edgeNodeAgent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/edgeNodeAgent.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/exstenion-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/exstenion-list.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/failing-ext-deployments.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/failing-ext-deployments.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/gitbjobcmd.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/gitbjobcmd.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/healthyhost.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/healthyhost.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/import-deployment-package.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/import-deployment-package.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/kubectl-listPods.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/kubectl-listPods.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/listresources.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/listresources.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/other-usage-kubeconfig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/other-usage-kubeconfig.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/rkelog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/rkelog.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/short-lived-token-img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/short-lived-token-img.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/successful_clusterlist.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/successful_clusterlist.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/upgrade-failing-deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/upgrade-failing-deployment.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/url_of_kubeConfig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/url_of_kubeConfig.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/co/viewMetrics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/co/viewMetrics.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/deployment-400.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/deployment-400.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/docker-limit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/docker-limit.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/en-logs-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/en-logs-details.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/en-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/en-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-export-options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-export-options.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-import.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-import.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-partial-export.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-partial-export.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-relm-settings.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-email.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-password.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-30days.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-30days.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part2.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part3.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/keycloak/keycloak-set-sso-part4.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/libvert-error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/libvert-error.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-admin-cluster-overview.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-admin-cluster-overview.jpeg -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-list.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-log-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-log-search.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-resources.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-admin-pod-resources.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-admin-single-node.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-admin-single-node.jpeg -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-explore-edgenode-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-explore-edgenode-system.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-grafana-login-error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-grafana-login-error.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-grafana-no-projects.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-grafana-no-projects.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/observability-grafana-user-has-no-email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/observability-grafana-user-has-no-email.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/o11y/orchestrator-admin-metrics-explorer.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/o11y/orchestrator-admin-metrics-explorer.jpeg -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/obsdashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/obsdashboard.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/orch-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/orch-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/pod-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/pod-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/specific-en-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/specific-en-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/sre_exporter/sre-exporter-delete-pod.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/sre_exporter/sre-exporter-delete-pod.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/sre_exporter/sre-exporter-healthy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/sre_exporter/sre-exporter-healthy.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/system-logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/system-logs.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/console-network-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/console-network-1.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/console-network-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/console-network-2.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/console-network-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/console-network-3.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/console-network-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/console-network-4.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/missing-registries.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/missing-registries.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ui/missing-roles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ui/missing-roles.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/user-groups.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/user-groups.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/ven-max-vm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/ven-max-vm.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/images/visudo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/troubleshooting/images/visudo.png -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/inconsistent_state_infra_deployment.rst: -------------------------------------------------------------------------------- 1 | ======================================================== 2 | Inconsistent State Between Infrastructure and Deployment 3 | ======================================================== 4 | 5 | Symptom 6 | ======= 7 | 8 | Infrastructure hosts show error 400 and there is inconsistent state of 9 | deployment between the Deployments tab of the dashboard and the deployment 10 | detail page. 11 | 12 | .. image:: images/deployment-400.png 13 | :alt: Deployment tab shows error 400 14 | 15 | Cause 16 | ===== 17 | 18 | Vault is sealed due to pod restart. 19 | 20 | Preconditions 21 | ============= 22 | 23 | - The Host is up and running correctly. 24 | - The Cluster is up and running correctly. 25 | - Errors are shown as in the symptoms screenshot. 26 | 27 | Steps 28 | ===== 29 | 30 | - Unseal Vault according to the instruction in :doc:`vault`. 31 | - Try to navigate to edge orchestration again, the errors should be gone. 32 | -------------------------------------------------------------------------------- /docs/developer_guide/troubleshooting/index.rst: -------------------------------------------------------------------------------- 1 | Developer Troubleshooting 2 | ========================= 3 | 4 | This section contains developer-oriented troubleshooting and complements 5 | the User Guide :doc:`/user_guide/troubleshooting/index` doc. 6 | 7 | .. toctree:: 8 | :maxdepth: 1 9 | 10 | eks_node_issues 11 | capture_logs 12 | o11y_orchestrator 13 | o11y_access 14 | argocd 15 | vault 16 | load_balancer 17 | inconsistent_state_infra_deployment 18 | virtual_edge_node 19 | edge_cluster_orchestrator 20 | app_orch 21 | keycloak 22 | hook_os 23 | ui 24 | sre_exporter 25 | -------------------------------------------------------------------------------- /docs/developer_guide/trusted_compute/arch/images/ContinuousMonitoring.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/trusted_compute/arch/images/ContinuousMonitoring.png -------------------------------------------------------------------------------- /docs/developer_guide/trusted_compute/arch/images/WorkloadProtection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/trusted_compute/arch/images/WorkloadProtection.png -------------------------------------------------------------------------------- /docs/developer_guide/trusted_compute/index.rst: -------------------------------------------------------------------------------- 1 | Trusted Compute 2 | =============== 3 | 4 | Trusted Compute is a set of software-defined security extensions that utilize hardware security capabilities of the Edge Node within the Edge Manageability Framework. 5 | 6 | A user can select and deploy trusted compute extensions on a node to achieve higher security assurances for their workloads. This extension enhances edge node protection through: 7 | 8 | - **Continuous Monitoring** and 9 | - **Workload Protection through Isolated Execution** 10 | 11 | Trusted Compute is a key aspect of |software_prod_name| that provides workload protections of the system. This section provides a comprehensive view of 12 | |software_prod_name| Trusted Compute extension and an overview of key components that help you monitor the trust status of the edge nodes and protect the workloads by isolated execution. 13 | 14 | .. toctree:: 15 | :hidden: 16 | :maxdepth: 1 17 | 18 | arch/architecture 19 | -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/arch/images/day0-prov-vm-wf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/arch/images/day0-prov-vm-wf.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/arch/images/day1-destroy-vm-wf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/arch/images/day1-destroy-vm-wf.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/arch/images/ven-design.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/arch/images/ven-design.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/arch/workflows.rst: -------------------------------------------------------------------------------- 1 | Lifecycle Workflows 2 | =================== 3 | 4 | Day 0 5 | ----- 6 | 7 | .. image:: images/day0-prov-vm-wf.png 8 | :alt: Day0 Workflow 9 | 10 | Day 1 11 | ----- 12 | 13 | .. image:: images/day1-destroy-vm-wf.png 14 | :alt: Day1 Workflow 15 | -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/deployment/baremetal_deployment.rst: -------------------------------------------------------------------------------- 1 | ================================ 2 | Installation On BareMetal Server 3 | ================================ 4 | 5 | The Virtual Edge Node provisioning tool streamlines VM setup on bare metal servers using automated scripts and templates. 6 | Start by preparing your server environment and following the provided instructions for efficient deployment. 7 | 8 | .. toctree:: 9 | :maxdepth: 1 10 | 11 | ../usage/how_it_works_content 12 | ../usage/getting_started 13 | ../usage/setup_virtual_edge_node 14 | ../usage/deploy_virtual_edge_node 15 | ../usage/manage_virtual_edge_node 16 | -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/deployment/deployment.rst: -------------------------------------------------------------------------------- 1 | Deployment 2 | ========== 3 | 4 | The Virtual Edge Node repository can be cloned on an Ubuntu\* OS version 22.04 or 24.04 machine. Then start creating virtual machines 5 | using standalone scripts for testing the provisioning flow. For more details, see the README documents stored in the vm-provisioning component. 6 | 7 | 8 | The VM-Provisioning tool is designed to deploy our Virtual Edge Node either On BareMetal physical servers or On Amazon Web Services\* (AWS\*) cloud, depending on your 9 | specific needs and preferences. This tool provides scripts and instructions to streamline the process, focusing on using Edge Microvisor Toolkit or Ubuntu OS for deployment. 10 | To get started, refer to the following sections for detailed instructions and guidance tailored to each deployment option: 11 | 12 | * :doc:`Bare-Metal Deployment ` 13 | * :doc:`Cloud Deployment ` 14 | 15 | .. toctree:: 16 | :hidden: 17 | :maxdepth: 1 18 | 19 | baremetal_deployment 20 | cloud_deployment 21 | -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/deployment/images/kvm_not_supported.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/deployment/images/kvm_not_supported.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/Microvisor_os_resource.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/Microvisor_os_resource.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/Microvisor_provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/Microvisor_provider.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/Ubuntu_os.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/Ubuntu_os.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/Ubuntu_os_provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/Ubuntu_os_provider.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/autoProvision_false.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/autoProvision_false.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/autoProvision_true.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/autoProvision_true.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/tutorials/images/host-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/tutorials/images/host-status.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/usage/images/Microvisor_Provision.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/usage/images/Microvisor_Provision.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/usage/images/Security_feature.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/usage/images/Security_feature.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/usage/images/UbuntuOS_Provision.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/usage/images/UbuntuOS_Provision.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/usage/images/provider_config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/developer_guide/virtual_edge_node/usage/images/provider_config.png -------------------------------------------------------------------------------- /docs/developer_guide/virtual_edge_node/usage/manage_virtual_edge_node.rst: -------------------------------------------------------------------------------- 1 | Manage Virtual Edge Node 2 | ======================== 3 | 4 | VMs Deletion 5 | ------------ 6 | 7 | Run the `destroy_vm.sh` script to delete VMs that have already been provisioned. 8 | 9 | .. code-block:: shell 10 | 11 | chmod +x ./scripts/create_vm.sh 12 | ./scripts/destroy_vm.sh 13 | 14 | Monitoring and Management 15 | ------------------------- 16 | 17 | Use the provided scripts and tools to monitor and manage the virtual edge nodes. This includes checking the status of VMs, updating configurations, and ensuring optimal performance. 18 | 19 | Useful Commands 20 | --------------- 21 | 22 | - **Check VM Status** 23 | 24 | .. code-block:: shell 25 | 26 | virsh list --all 27 | 28 | - **Docker Management** 29 | 30 | .. code-block:: shell 31 | 32 | docker ps 33 | 34 | - **Vagrant Status** 35 | 36 | .. code-block:: shell 37 | 38 | vagrant status 39 | 40 | Ensure that all services are running and configurations are up-to-date to maintain seamless operation of virtual edge nodes. 41 | -------------------------------------------------------------------------------- /docs/release_notes/index.rst: -------------------------------------------------------------------------------- 1 | Release Notes 2 | ============= 3 | 4 | In the following sections, you can stay up-to-date 5 | with the latest enhancements, bug fixes, and 6 | features introduced in our product. 7 | 8 | Version 3.0 9 | ------------------ 10 | 11 | - :doc:`/release_notes/rel_notes_3.0` 12 | - :doc:`/release_notes/kpi_3.0` 13 | - :doc:`/release_notes/third_party_components_3.0` 14 | - :doc:`/release_notes/containers_helm_charts_3.0` 15 | 16 | 17 | .. toctree:: 18 | :hidden: 19 | 20 | version_3.0 21 | 22 | -------------------------------------------------------------------------------- /docs/release_notes/version_3.0.rst: -------------------------------------------------------------------------------- 1 | Version 3.0 2 | ====================== 3 | 4 | |software_prod_name| version 3.0 consists of the following releases and 5 | complies with key performance indicators: 6 | 7 | - :doc:`/release_notes/rel_notes_3.0` 8 | - :doc:`/release_notes/kpi_3.0` 9 | - :doc:`/release_notes/third_party_components_3.0` 10 | - :doc:`/release_notes/containers_helm_charts_3.0` 11 | 12 | 13 | 14 | 15 | 16 | .. toctree:: 17 | :hidden: 18 | 19 | rel_notes_3.0 20 | kpi_3.0 21 | third_party_components_3.0 22 | containers_helm_charts_3.0 23 | 24 | -------------------------------------------------------------------------------- /docs/shared/shared_adv_edge_node.rst: -------------------------------------------------------------------------------- 1 | Edge Orchestrator Configuration for Edge Node 2 | ################################################ 3 | 4 | Edge Orchestrator uses default settings for installation. If your network or services require specific settings, see the following information: 5 | 6 | * netIP - Set by default to dynamic. This is required to prevent communication problems with the Kubernetes cluster. 7 | This value can be set to static, but it is not recommended. 8 | * firewallCfgAllow - Set the environment firewall to Allow. Retain the existing ports, ipVer and protocol configurations. 9 | Use a blank value (“”) or remove the elements if not required for firewall configuration. 10 | * ntpServer - Update to the NTP server used by the environment. 11 | Reachable by the network. 12 | -------------------------------------------------------------------------------- /docs/shared/shared_cloud_ts_sync_root_app.rst: -------------------------------------------------------------------------------- 1 | Resolving Incomplete Component Deployment 2 | =========================================================== 3 | 4 | Slow network connections or failures may cause the ArgoCD\* tool's retry limit to be reached, and some applications may not deploy successfully. 5 | 6 | Reset the ``root-app`` 7 | ------------------------- 8 | 9 | #. Access the ArgoCD tool at ``https://argocd.``, for example, ``https://argocd.staging.espdstage.infra-host.com``. 10 | 11 | #. Run the following command to find the ArgoCD password: 12 | 13 | .. code-block:: shell 14 | 15 | kubectl get secret -n argocd argocd-initial-admin-secret -o jsonpath={.data.password}|base64 -d 16 | 17 | 18 | #. Enter the ArgoCD tool URL in the browser. 19 | #. Log in using ``admin`` as the username, and the password from the earlier step. 20 | #. Open the ``root-app`` application and check its status. 21 | #. Click **Sync** > **Synchronize** to trigger an application update. 22 | -------------------------------------------------------------------------------- /docs/shared/shared_images/mt_project_complete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/mt_project_complete.png -------------------------------------------------------------------------------- /docs/shared/shared_images/mt_project_create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/mt_project_create.png -------------------------------------------------------------------------------- /docs/shared/shared_images/mt_project_delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/mt_project_delete.png -------------------------------------------------------------------------------- /docs/shared/shared_images/mt_project_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/mt_project_menu.png -------------------------------------------------------------------------------- /docs/shared/shared_images/mt_project_overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/mt_project_overview.png -------------------------------------------------------------------------------- /docs/shared/shared_images/tenancy.drawio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/shared/shared_images/tenancy.drawio.png -------------------------------------------------------------------------------- /docs/shared/shared_next_steps.rst: -------------------------------------------------------------------------------- 1 | Next Steps 2 | ========== 3 | 4 | See the web UI for more options, and review the documentation. 5 | 6 | * Web UI - \https://web-ui.CLUSTER_FQDN 7 | * Documentation - \https://web-ui.CLUSTER_FQDN/docs/ 8 | -------------------------------------------------------------------------------- /docs/shared/shared_on_prem_rke2_deployment.rst: -------------------------------------------------------------------------------- 1 | Other RKE2 Deployment Issues 2 | ============================ 3 | 4 | #. Pod Creation Fails 5 | 6 | At the time of writing this document, this is a `known RKE2 issue `_. 7 | 8 | When checking the logs of the affected pods, you may observe the following error: 9 | 10 | .. code-block:: bash 11 | 12 | plugin type="portmap" failed (add): failed to open iptables: exec: "iptables": executable file not found in $PATH 13 | 14 | To resolve this problem, please install `iptables`. 15 | -------------------------------------------------------------------------------- /docs/shared/shared_on_prem_ts_sync_root_app.rst: -------------------------------------------------------------------------------- 1 | Resolving Incomplete Component Deployment 2 | ========================================= 3 | 4 | Slow network connections or failures may cause the ArgoCD retry limit to 5 | be reached, and some applications may not deploy successfully. 6 | 7 | Reset the ``root-app`` 8 | ------------------------- 9 | 10 | #. Run the command below to find the IP address for ArgoCD tool. 11 | 12 | .. code-block:: shell 13 | 14 | kubectl get svc -n argocd -o json argocd-server|jq '.status.loadBalancer.ingress[0].ip' 15 | "xx.xx.xx.xx" 16 | 17 | #. Run the command below to find the ArgoCD password. 18 | 19 | .. code-block:: shell 20 | 21 | kubectl get secret -n argocd argocd-initial-admin-secret -o jsonpath={.data.password}|base64 -d 22 | 23 | 24 | #. From a browser, open the ArgoCD IP address. 25 | #. Log in using ``admin`` as the username, and the password from the earlier step. 26 | #. Open the ``root-app`` application and check its status. 27 | #. Click **Sync** > **Synchronize** to trigger an application update. 28 | -------------------------------------------------------------------------------- /docs/shared/shared_registration_info_mismatch.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | Registration Information Mismatch 4 | ================================= 5 | 6 | .. note:: 7 | 8 | If the edge device's reported information does not match the registered host's information, the status will become **Connected - Error** in the UI. 9 | 10 | The |software_prod_name| APIs (see :doc:`../api/index`) will report a status of **Host Registration Failed 11 | due to mismatch of UUID** or **Host Registration Failed due to mismatch of Serial Number**, depending on the type of mismatched information. 12 | 13 | You can also see the details in the logs of the `mi-onboarding-manager` component by searching for the 14 | `Device not found` and the `Node doesn't exist` strings through the cluster observability stack `Cluster Observability <../user_guide/monitor_deployments/grafana_content.html#cluster-observability>`__. 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/shared/shared_traefik_rate_limit.rst: -------------------------------------------------------------------------------- 1 | Configure Traefik\* Rate Limit 2 | ---------------------------------------- 3 | 4 | .. warning:: 5 | You must configure the Traefik\* rate limit based on the resources and expected load of each Edge Orchestrator system. 6 | 7 | Rate Limit is applicable to each individual cluster. See the `Traefik Rate Limit Docs `__ for information about configuring this feature. A typical edge node can have a peak of 2,000 requests per minute. The following example shows how to configure the rate limit for Traefik. These values can be adjusted based on the expected load of the system. 8 | 9 | .. code-block:: yaml 10 | 11 | traefik: 12 | rateLimit: 13 | average: 2000 14 | period: 1m 15 | burst: 1000 16 | -------------------------------------------------------------------------------- /docs/substitutions.txt: -------------------------------------------------------------------------------- 1 | .. 2 | [comment] These are substitutions for content in Edge Orchestrator 3 | Documentation: 4 | 5 | .. |software_prod_name| replace:: Edge Orchestrator 6 | 7 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/alerting.rst: -------------------------------------------------------------------------------- 1 | Manage Alerts 2 | ============================ 3 | 4 | In this section, you will find instructions to manage your **Alerts**. It includes: 5 | 6 | * :doc:`/user_guide/additional_howtos/alerts_config` 7 | * :doc:`/user_guide/additional_howtos/alerts_email` 8 | 9 | .. toctree:: 10 | :hidden: 11 | 12 | 13 | alerts_config 14 | alerts_email 15 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/delete_cluster_template.rst: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Delete Cluster Template 5 | ================================ 6 | 7 | You can delete a previously imported cluster template. 8 | 9 | .. note:: 10 | You cannot delete a cluster template that is either assigned as the default cluster template or was used to create existing clusters. 11 | 12 | Perform the following steps to delete a cluster template: 13 | 14 | 1. Identify the cluster template you want to delete in the **Cluster Templates** page. 15 | 16 | 2. In the **Action** column, click the three-dot (...) icon, then click **Delete**. 17 | 18 | .. figure:: images/delete_customer_template.png 19 | :width: 100 % 20 | :alt: Delete Cluster Template 21 | 22 | 3. On the confirmation window, click **Delete**. 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/export_cluster_template.rst: -------------------------------------------------------------------------------- 1 | 2 | 3 | Export Cluster Template 4 | ================================ 5 | 6 | You can export a cluster template in JSON format to a file. This feature allows you to edit your template files locally. 7 | Once exported, you can edit the JSON files using the desired text editor and assign the template a new version number, making it easy to manage and maintain cluster templates. 8 | Maintaining each version of a cluster template using a source control system such as GitHub is recommended. 9 | 10 | Do the following steps to export a cluster template: 11 | 12 | 1. Identify the cluster template you want to export in the **Cluster Templates** page. 13 | 14 | 2. In the **Action** column, click the three-dot (...) icon, then click **Export Template**. 15 | 16 | .. figure:: images/export_cluster_template.png 17 | :width: 100 % 18 | :alt: Export Customer Template 19 | 20 | You can also export template from the "View Cluster Template Details" page. 21 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/add_ssh_key_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/add_ssh_key_menu.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/advanced_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/advanced_settings.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/alerts/EO-alert-definitions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/alerts/EO-alert-definitions.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/alerts/EO-alert-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/alerts/EO-alert-details.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/alerts/EO-alert-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/alerts/EO-alert-list.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/alerts/EO-email-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/alerts/EO-email-config.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/cluster_details1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/cluster_details1.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/cluster_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/cluster_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/contextual_maintenance_menu_region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/contextual_maintenance_menu_region.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/contextual_region_add_maintenance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/contextual_region_add_maintenance.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/create_cluster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/create_cluster.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/default_cluster_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/default_cluster_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/delete_customer_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/delete_customer_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/delete_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/delete_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/delete_ssh_key_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/delete_ssh_key_menu.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/deployment_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/deployment_metadata.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/deployments_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/deployments_main.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/export_cluster_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/export_cluster_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/import_cluster_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/import_cluster_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/metadata_rule.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/metadata_rule.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/os_profile_drawer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/os_profile_drawer.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/schedule_list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/schedule_list.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/schedule_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/schedule_main.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/schedule_repeat.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/schedule_repeat.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/specifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/specifications.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/ssh-key-using-host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/ssh-key-using-host.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/ssh_key_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/ssh_key_menu.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/success_maintenance_menu_region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/success_maintenance_menu_region.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_available_emt_en.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_available_emt_en.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_available_emt_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_available_emt_hosts.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_done_ubuntu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_done_ubuntu.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_profiles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_profiles.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_progress_emt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_progress_emt.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_status.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_status_host_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_status_host_name.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/update_updating_ubuntu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/update_updating_ubuntu.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/view_cluster_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/view_cluster_template.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/view_os_profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/view_os_profile.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/images/workload_view_vm-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/images/workload_view_vm-2.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/import_cluster_template.rst: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Import Cluster Template 5 | ================================ 6 | 7 | You can import a cluster template using a file in JSON format and add it to the **Clusters Templates** page. 8 | 9 | .. note:: 10 | When importing templates from JSON files, the version field in template content is considered the version of the template, and an error message is displayed if the version field is not specified. Also, an error message is displayed if you select an already existing version. 11 | 12 | To import a cluster template, do the following: 13 | 14 | 1. In the **Cluster Templates** page, click **Import Template**. 15 | 16 | .. figure:: images/import_cluster_template.png 17 | :width: 100 % 18 | :alt: Import Cluster Template 19 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/os_profile_drawer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/os_profile_drawer.png -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/set_default_cluster_template.rst: -------------------------------------------------------------------------------- 1 | Set Default Cluster Template 2 | ================================ 3 | 4 | When you set a template as the default, it displays as the default option when creating a cluster. 5 | However, when you create a single host cluster while configuring the host, the default template will be automatically selected. 6 | For more information, see :doc:`/user_guide/set_up_edge_infra/provision_host`. 7 | 8 | .. note:: 9 | The user can only assign one template as the default template at any time. 10 | 11 | To assign the default template, do the following: 12 | 13 | 1. In the **Cluster Templates** page, select the cluster template that you want to set as default. 14 | 15 | 2. Click the three-dot (...) icon in the **Actions** column and select **Set as default**. The cluster template remains as default. 16 | 17 | .. figure:: images/default_cluster_template.png 18 | :width: 100 % 19 | :alt: Default Cluster Template 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/user_guide/additional_howtos/view_os_profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/additional_howtos/view_os_profile.png -------------------------------------------------------------------------------- /docs/user_guide/concepts/images/cluster_usergroups.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/concepts/images/cluster_usergroups.png -------------------------------------------------------------------------------- /docs/user_guide/concepts/images/define_criteria.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/concepts/images/define_criteria.png -------------------------------------------------------------------------------- /docs/user_guide/concepts/images/os_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/concepts/images/os_selection.png -------------------------------------------------------------------------------- /docs/user_guide/concepts/index.rst: -------------------------------------------------------------------------------- 1 | Concepts 2 | ======== 3 | 4 | The Concepts section provides some key concepts, explanation, and examples that 5 | will help you to work effectively with |software_prod_name|. 6 | 7 | This section explains the following: 8 | 9 | * :doc:`metadata_example` 10 | 11 | * :doc:`/user_guide/concepts/cluster_usergroups` 12 | 13 | * :doc:`/shared/shared_os_profile`. You can also refer to the 14 | :doc:`/api/edge_infra_manager` API. 15 | 16 | * :doc:`nztp` 17 | 18 | * :doc:`/shared/shared_update_provider`. You can also refer to the 19 | :doc:`/api/edge_infra_manager` API. 20 | 21 | * :doc:`/shared/shared_secure_boot_opt_in` 22 | 23 | .. toctree:: 24 | :hidden: 25 | 26 | metadata_example 27 | cluster_usergroups 28 | ../../shared/shared_os_profile 29 | nztp 30 | ../../shared/shared_update_provider 31 | ../../shared/shared_secure_boot_opt_in 32 | 33 | -------------------------------------------------------------------------------- /docs/user_guide/concepts/nztp.rst: -------------------------------------------------------------------------------- 1 | Near Zero-Touch Provisioning (nZTP) 2 | =================================== 3 | 4 | |software_prod_name|\ can install an Operating System (OS) on edge devices 5 | with just a few clicks. 6 | 7 | Once a device gets onboarded, the |software_prod_name|\ automatically installs 8 | an OS (the default OS) on it without the need for additional configuration on 9 | the device from the user. 10 | 11 | This nZTP feature is disabled by default but you can enable it at installation 12 | or run time. See :doc:`/shared/shared_update_provider`. Also see the 13 | :doc:`/api/edge_infra_manager` API. 14 | 15 | You can either disable the nZTP feature, or change the default OS to one of the 16 | supported OSes described in :doc:`/shared/shared_os_profile`. 17 | 18 | Each project may have its own automatic provisioning configuration, with 19 | different default OS profiles specified. 20 | -------------------------------------------------------------------------------- /docs/user_guide/get_started_guide/images/get_started.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/get_started_guide/images/get_started.png -------------------------------------------------------------------------------- /docs/user_guide/how_it_works/images/how_it_works2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/how_it_works/images/how_it_works2.png -------------------------------------------------------------------------------- /docs/user_guide/images/os_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/images/os_selection.png -------------------------------------------------------------------------------- /docs/user_guide/intel_solutions/index.rst: -------------------------------------------------------------------------------- 1 | Deploy Intel Solutions 2 | ========================================================== 3 | 4 | This section guides you through the deployment of several Intel® solutions for the edge, including AI-Suites, and 5 | real-time applications on top of Intel® Open Edge Platform AI. 6 | 7 | 1. `Open Edge Intel Platform Software Catalog - Pallete Defect Detection Sample Application v2.3.0 `__. 8 | 2. `Open Edge Intel Platform Software Catalog - Image-Based Video Search Sample Application v1.0.0 `__. 9 | 3. `Open Edge Intel Platform Software Catalog - Chat Q&A Sample Application Sample Application v1.1.2 `__. 10 | 11 | -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/alerts/EO-alert-definitions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/alerts/EO-alert-definitions.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/alerts/EO-alert-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/alerts/EO-alert-details.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/alerts/EO-alert-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/alerts/EO-alert-list.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/alerts/EO-email-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/alerts/EO-email-config.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/audit_logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/audit_logs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/console_access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/console_access.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/delete_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/delete_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/deploy_status1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/deploy_status1.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/edgenode_host_agentlogs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/edgenode_host_agentlogs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/edgenode_host_healthchecklogs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/edgenode_host_healthchecklogs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/edgenode_host_viewlogs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/edgenode_host_viewlogs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_cluster_container_app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_cluster_container_app.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_cluster_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_cluster_dashboard.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_cluster_pod_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_cluster_pod_dashboard.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_cluster_vm_app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_cluster_vm_app.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_container_app_logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_container_app_logs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_host_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_host_dashboard.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/en_viewcluster_link.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/en_viewcluster_link.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/filter_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/filter_metadata.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/grafana_signin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/grafana_signin.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/host_status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/host_status.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/host_status1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/host_status1.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/orchestrator_cluster_dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/orchestrator_cluster_dashboard.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/orchestrator_node_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/orchestrator_node_details.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/orchestrator_pod_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/orchestrator_pod_details.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/orchestrator_pod_logs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/orchestrator_pod_logs.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/provisioning_time.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/provisioning_time.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/remote_desktop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/remote_desktop.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/upgrade_deploy1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/upgrade_deploy1.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/upgrade_deploy2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/upgrade_deploy2.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/view_deploymentdetails.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/view_deploymentdetails.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/images/view_metrics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/monitor_deployments/images/view_metrics.png -------------------------------------------------------------------------------- /docs/user_guide/monitor_deployments/index.rst: -------------------------------------------------------------------------------- 1 | Dashboard and Alerts 2 | ============================================= 3 | 4 | Monitor the status of your deployments and the health of host infrastructure 5 | from the |software_prod_name| dashboard and view the alerts in the 6 | :doc:`Alerts ` page. 7 | To configure alerts, :doc:`configure alerts ` page. 8 | 9 | * :doc:`/user_guide/monitor_deployments/status_deployment` 10 | * :doc:`/user_guide/monitor_deployments/alerts_view` 11 | * :doc:`/user_guide/monitor_deployments/grafana_content` 12 | * :doc:`/user_guide/monitor_deployments/orchestrator_observability` 13 | * :ref:`kpi` 14 | 15 | .. toctree:: 16 | :hidden: 17 | 18 | status_deployment 19 | alerts_view 20 | grafana_content 21 | orchestrator_observability 22 | kpi 23 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/add_a_deploy_pkg_profile.rst: -------------------------------------------------------------------------------- 1 | Add a Deployment Package Profile 2 | =============================================== 3 | 4 | The **Add Profile** feature allows you to use a different set of application 5 | profiles and set it as default. 6 | 7 | To add a profile, perform the following steps: 8 | 9 | 1. Click **Add Profile** in the **Deployment Package Profile** page. The **Add Profile** page appears: 10 | 11 | .. figure:: images/add_deployment_profile.png 12 | :scale: 50 % 13 | :alt: Add Profile 14 | 15 | #. Enter the profile name in the **Name** field. 16 | #. Enter a brief description of the profile. This is optional. 17 | #. If you want to set the profile as the default deployment profile, click the **Set as Default** option. 18 | #. In the **Applications** field, all applications of that package are listed. You can select and change the profiles from the **Profile** drop-down menu. 19 | #. Click **Add Profile**. 20 | 21 | The profile is added in the **Deployment Package Profile** page. 22 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/app_details.rst: -------------------------------------------------------------------------------- 1 | View Application Details 2 | ============================== 3 | You can view the application details, including the details of the application and the profiles associated with it. To view the details of an application package, do the following: 4 | 5 | 1. In the **Application Packages** page, select the desired application package to view its details. 6 | 7 | #. Click the three-dot icon in the **Actions** column and select **View Details**. 8 | 9 | #. See details: 10 | 1. Application details - details of the application. 11 | 2. Application profiles - details of the profiles associated with the application. 12 | 13 | .. figure:: images/application_details.png 14 | :scale: 40 % 15 | :alt: Details of Application 16 | 17 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/delete_application.rst: -------------------------------------------------------------------------------- 1 | Delete an Application 2 | =================================================== 3 | 4 | You can delete an application that is deployed on the server. 5 | 6 | .. note:: Once deleted, an application cannot be retrieved. 7 | 8 | Perform the following steps to delete an application: 9 | 10 | 1. In the **Applications** page, identify the application that you want to 11 | delete. 12 | 13 | #. In the **Action** column, click the three-dot icon then click **Delete**. 14 | 15 | .. figure:: images/delete_applications.png 16 | :scale: 70 % 17 | :alt: Delete an application 18 | 19 | #. On the confirmation window, click **Delete**. 20 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/delete_deploy_pack.rst: -------------------------------------------------------------------------------- 1 | Delete Deployment Packages 2 | ================================== 3 | You can delete deployment packages using the the **Delete** function 4 | when those deployment packages are not in the deployed state. 5 | Applications that are associated with the package are not deleted. 6 | 7 | .. note:: 8 | 9 | - Once deleted, an deployment package cannot be retrieved. 10 | - The applications that are associated with the package are not deleted. 11 | 12 | Perform the following steps to delete an application package: 13 | 14 | 1. In the **Deployment Packages** page, identify the package that 15 | you want to delete. 16 | 17 | #. In the **Actions** column, click the three-dot menu, and then click **Delete**: 18 | 19 | .. figure:: images/delete_deploymentpack.png 20 | :scale: 50 % 21 | :alt: Delete Deployment Package 22 | 23 | Alternatively, you can go to the 24 | :doc:`Deployment Package Details ` 25 | page and delete the deployment package. 26 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/deploy_pack_details.rst: -------------------------------------------------------------------------------- 1 | View Deployment Package Details 2 | ===================================== 3 | 4 | You can view the deployment package details, including the creation date, deployment status, and the applications available in the package. 5 | To view the details of an deployment package, do the following: 6 | 7 | 1. In the **Deployment Packages** page, select the desired deployment package to view its details. 8 | 9 | #. Click the three-dot icon in the **Actions** column and select **Details**. 10 | 11 | #. The deployment package details page appears. 12 | 13 | #. Deployment Package Name 14 | #. Details of the deployment package like version, creation date, last update etc. 15 | #. Details of the applications that are part of the application package. 16 | #. Perform actions like deploy, edit, and delete. 17 | 18 | .. figure:: images/deploy_pack_details.png 19 | :scale: 100 % 20 | :alt: Deployment Package Details 21 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/deployment_delete.rst: -------------------------------------------------------------------------------- 1 | Delete Deployment 2 | =========================================================== 3 | 4 | Do the following to delete a deployment: 5 | 6 | 1. In the **Deployments** page, identify the instance of deployment that you 7 | want to delete. 8 | #. In the **Action** column, click the three-dot icon menu, and then click 9 | **Delete**. 10 | 11 | The deployment is deleted. 12 | 13 | .. figure:: images/delete_deploy.png 14 | :scale: 50 % 15 | :alt: Delete a deployment 16 | 17 | .. note:: 18 | If you want to change or update the metadata for a deployment, you must delete the instance of that deployment, create a new deployment, and then add the metadata. 19 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/edit_registry.rst: -------------------------------------------------------------------------------- 1 | Edit Registry 2 | ======================= 3 | You can edit the location, type, and inventory using the **Edit Registry** feature. 4 | 5 | To edit a registry, perform the following steps: 6 | 7 | 1. In the **Registries** page, select the registry that you want to edit. 8 | 9 | #. In the **Action** column, click the three-dot menu, and then click **Edit**. 10 | The **Edit Registry** page appears. 11 | 12 | .. figure:: images/edit_registry.png 13 | :scale: 80 % 14 | :alt: Edit Registry 15 | 16 | #. Edit the **Location**, **Inventory**, or **Type** fields. 17 | 18 | #. Click **Ok**. 19 | 20 | .. note:: You cannot edit the name of the registry. 21 | 22 | Reference for Registry 23 | ------------------------ 24 | 25 | :doc:`/developer_guide/application_developer_workflow/deployment-packages/registry-yaml-reference` 26 | describes the YAML format for the Registry configuration file and describes the 27 | fields in greater detail. 28 | -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_applications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_applications.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_deployment_profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_deployment_profile.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_profile.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_profile_package.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_profile_package.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_registry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_registry.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/add_site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/add_site.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/application_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/application_details.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/application_page0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/application_page0.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/application_page1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/application_page1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/application_registry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/application_registry.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/auto_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/auto_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/clone_deploypack_new.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/clone_deploypack_new.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/console_access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/console_access.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/create_deploy_pack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/create_deploy_pack.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/delete_applications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/delete_applications.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/delete_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/delete_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/delete_deploymentpack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/delete_deploymentpack.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/delete_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/delete_host.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deploy_pack_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deploy_pack_details.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deploy_status1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deploy_status1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deployment-package-relationships.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deployment-package-relationships.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deployment_detailsnew.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deployment_detailsnew.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deployment_pack_extensions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deployment_pack_extensions.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deployment_pack_home.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deployment_pack_home.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/deployments_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/deployments_main.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_app4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_app4.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_app6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_app6.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_deploy1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_deploy1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_deploy2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_deploy2.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_deploypackage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_deploypackage.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/edit_registry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/edit_registry.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/endpoint-view-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/endpoint-view-1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/import_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/import_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/interconnect-arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/interconnect-arch.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/interconnect-select-network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/interconnect-select-network.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/manual_deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/manual_deployment.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/override_values.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/override_values.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/param_template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/param_template.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/app-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/app-details.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/app-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/app-profile.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/app-running.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/app-running.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/app-source.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/app-source.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/cli-secret.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/cli-secret.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/cluster-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/cluster-view.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/deploy-info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/deploy-info.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/manual-deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/manual-deployment.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/nginx-welcome.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/nginx-welcome.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/select-applications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/select-applications.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/select-deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/select-deploy.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/quick_start/user-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/quick_start/user-profile.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/remote_desktop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/remote_desktop.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/set_up_deploy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/set_up_deploy.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/upgrade_deploy1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/upgrade_deploy1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/upgrade_deploy2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/upgrade_deploy2.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/workload_view_pod-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/workload_view_pod-1.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/workload_view_pod-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/workload_view_pod-2.png -------------------------------------------------------------------------------- /docs/user_guide/package_software/images/workload_view_vm-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/package_software/images/workload_view_vm-2.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/accessing_clusters.rst: -------------------------------------------------------------------------------- 1 | Organize Cluster Access with a Kubeconfig File 2 | ============================================================================== 3 | 4 | A Kubeconfig file is a configuration file that defines and manages access to 5 | Kubernetes clusters. It is a YAML file that stores cluster authentication information. 6 | 7 | You can download or copy the Kubeconfig file to access clusters deployed on the edge node. 8 | To do so, go to the **Cluster List** page, select the cluster, and in the **Actions** column, click **Download Kubeconfig File**. 9 | 10 | To copy the contents of the Kubeconfig file, go to the **Cluster List** page, select the cluster, and in the **Actions** column, click the three-dot icon and then click **Copy Kubeconfig File**. 11 | 12 | 13 | .. figure:: images/downloadkubeconfig.png 14 | :width: 100 % 15 | :alt: Download and Copy Kubeconfig 16 | 17 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/delete_clusters.rst: -------------------------------------------------------------------------------- 1 | Delete Clusters 2 | ================== 3 | 4 | To delete a cluster, do the following: 5 | 6 | 1. Click the **Infrastructure** tab at the top menu to view the **Clusters** page. 7 | On the **Clusters** page, you can view the following list of available clusters. 8 | 9 | 2. Click the three-dot (...) icon in the **Actions** column for the desired cluster 10 | and select **Delete**. 11 | 12 | .. figure:: images/delete_cluster.png 13 | :width: 100 % 14 | :alt: Delete Cluster 15 | 16 | A window pops-up to confirm the deletion. 17 | 18 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/edit_host.rst: -------------------------------------------------------------------------------- 1 | Edit Host 2 | ========================================================================= 3 | 4 | You can edit **Provisioned**, **Onboarded** and **Registered** hosts. Perform the following steps 5 | to edit a host: 6 | 7 | 1. Select the host you want to edit in the **Hosts** page. 8 | 9 | #. In the **Action** column, click the three-dot menu, and then click 10 | **Edit**. The **Edit Host** page appears 11 | 12 | .. figure:: images/edit_host.png 13 | :alt: Edit Host page 14 | 15 | #. Edit the required fields on this page and click **Next**. 16 | 17 | #. Click **Save** to save the host. 18 | 19 | After the updates are processed, you will be redirected to the **Hosts** page. 20 | 21 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/add-db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/add-db.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/add_region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/add_region.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/add_site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/add_site.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/add_site_button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/add_site_button.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/add_subregion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/add_subregion.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/advanced_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/advanced_settings.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/amt_bios_disable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/amt_bios_disable.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/amt_bios_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/amt_bios_menu.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/boot-option.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/boot-option.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/clear-tpm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/clear-tpm.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/cluster_details1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/cluster_details1.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/cluster_details2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/cluster_details2.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/cluster_list_new.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/cluster_list_new.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/cluster_list_new1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/cluster_list_new1.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/configure_host_labels.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/configure_host_labels.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/confirm_host_deauthorization.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/confirm_host_deauthorization.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/create_cluster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/create_cluster.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/create_cluster_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/create_cluster_host.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/deauthorize_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/deauthorize_host.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/default_cluster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/default_cluster.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/delete_cluster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/delete_cluster.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/delete_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/delete_host.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/delete_host_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/delete_host_details.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/delete_region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/delete_region.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/deployment_metadata.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/deployment_metadata.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/devices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/devices.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/disable_unwanted_boot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/disable_unwanted_boot.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/download-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/download-template.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/downloadkubeconfig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/downloadkubeconfig.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/edit_cluster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/edit_cluster.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/edit_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/edit_host.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/edit_region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/edit_region.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/edit_site_button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/edit_site_button.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/filter_deauthorized_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/filter_deauthorized_hosts.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/fixed_bootorder_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/fixed_bootorder_settings.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/host_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/host_details.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/host_label.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/host_label.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/host_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/host_main.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/httpv4-enabled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/httpv4-enabled.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/httpv4v6-enabled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/httpv4v6-enabled.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/instances.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/instances.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/io_devices.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/io_devices.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/loca-devices-complete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/loca-devices-complete.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/loca-site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/loca-site.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/locations_homepage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/locations_homepage.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/onboard_host_action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/onboard_host_action.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/onboarded_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/onboarded_hosts.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/onboarded_hosts_details2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/onboarded_hosts_details2.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_host_action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_host_action.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_host_dropdown_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_host_dropdown_menu.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_host_labels.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_host_labels.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_host_status_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_host_status_menu.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_os_profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_os_profile.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_os_public_ssh_key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_os_public_ssh_key.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provision_site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provision_site.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/provisioned_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/provisioned_hosts.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/region_detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/region_detail.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host_automatic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host_automatic.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host_automatic_provision.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host_automatic_provision.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host_details.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host_success.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host_success.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/register_host_success_automatic_provision.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/register_host_success_automatic_provision.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/registered_host_status_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/registered_host_status_menu.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/registered_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/registered_hosts.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/resources.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/resources.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/secure-boot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/secure-boot.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/site_info_pane.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/site_info_pane.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/site_info_via_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/site_info_via_name.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/specifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/specifications.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/start-options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/start-options.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/status_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/status_details.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/template.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/template_end.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/template_end.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/tls.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/tls.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/upload.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/upload.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/usb-boot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/usb-boot.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/images/vmedia.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/set_up_edge_infra/images/vmedia.png -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/location/delete_region.rst: -------------------------------------------------------------------------------- 1 | Delete Region 2 | ================== 3 | 4 | .. note:: 5 | You cannot delete regions that are associated with any site. 6 | 7 | To delete regions that are the parents of any other regions, you must need to delete the sub-regions first. 8 | See sites and sub-regions in the region details 9 | :doc:`/user_guide/set_up_edge_infra/location/view_region_detail`. 10 | 11 | To delete a region: 12 | 13 | #. Go to the **Locations** page. 14 | #. Find the **Region** you want to delete by expanding the hierarchy by clicking on `>` next to an existing region. 15 | #. Click the three dots and then click **Delete**. 16 | 17 | .. figure:: ../images/delete_region.png 18 | :alt: Delete region 19 | 20 | #. On the confirmation window, click **Delete**. The region will be deleted. 21 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/location/delete_site.rst: -------------------------------------------------------------------------------- 1 | Delete Site 2 | =================== 3 | 4 | .. note:: 5 | You cannot delete sites that are associated with any host. 6 | 7 | Do the following to delete a site: 8 | 9 | #. Go to the **Locations** page. 10 | #. Expand the hierarchy by clicking `>` next to an existing region or sub region until you identify the desired site. 11 | #. Click the three dots. select **Delete**. 12 | #. On the confirmation window, click **Delete**. The site will be deleted. 13 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/location/view_region_detail.rst: -------------------------------------------------------------------------------- 1 | View and Edit Region Details 2 | ============================ 3 | 4 | Do the following to view the details of a region. 5 | 6 | #. Go to the **Locations** page. 7 | #. Select either the top-level region or expand the hierarchy by clicking on `>` next to an existing region. 8 | #. Click the three dots. Click **View Details** 9 | 10 | .. figure:: ../images/edit_region.png 11 | :alt: Edit region 12 | 13 | #. The **Region Detail** pane appears. 14 | 15 | In the **Region Detail** page, click **Region Detail** and select **Edit**. The **Region Edit** page appears. 16 | 17 | The Region Edit page displays the region name, type, and parent and you can update these details, if required. 18 | Note that the **Region Id** is automatically generated and cannot be modified. 19 | 20 | .. figure:: ../images/region_detail.png 21 | :alt: Region details 22 | 23 | You can also update or edit the :ref:`advanced settings `. 24 | -------------------------------------------------------------------------------- /docs/user_guide/set_up_edge_infra/onboard_host.rst: -------------------------------------------------------------------------------- 1 | Onboard Host 2 | ===================================================================== 3 | 4 | The **Onboard Host** feature allows the User to onboard into the Edge Orchestrator a previously registered Host. 5 | 6 | #. Go to the **Infrastructure tab**, click **Hosts** on the left menu and select the **Registered** tab. 7 | 8 | .. figure:: images/registered_hosts.png 9 | :alt: Registered Hosts 10 | 11 | #. Find a host in `Connected` state 12 | 13 | #. Go to the **Actions** column and click the three-dot icon for the desired 14 | host, then click **Onboard**. 15 | 16 | .. figure:: images/onboard_host_action.png 17 | :alt: Onboard Host 18 | 19 | Once the node is onboarded, you can find it on the **Onboarded** tab. 20 | Delete the host if you want to remove it from this page. 21 | 22 | .. note:: You must still complete the onboarding process for the edge node for it to appear in the UI, 23 | but you do not have to enter a user name or password in the onboarding steps. 24 | -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/argocd-restart-querier.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/argocd-restart-querier.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/boot_entry_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/boot_entry_selection.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/clear_tpm_bios.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/clear_tpm_bios.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-1.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-2.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-3.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-4.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment-host-metadata-ztp-6.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/deployment_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/deployment_error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/grafana-panel-error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/grafana-panel-error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/onboarding_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/onboarding_error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/os_boot_failed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/os_boot_failed.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/provisioning_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/provisioning_error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/register_host_already_existing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/register_host_already_existing.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/registered_host_connection_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/registered_host_connection_error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/registered_host_view_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/registered_host_view_error.png -------------------------------------------------------------------------------- /docs/user_guide/troubleshooting/images/registered_hosts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/open-edge-platform/edge-manage-docs/1c9d2c178218b01e90aafe0e5a5f6d1efc3b6ff6/docs/user_guide/troubleshooting/images/registered_hosts.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # SPDX-License-Identifier: Apache-2.0 3 | 4 | # Sphinx 5 | sphinx~=8.2.3 6 | 7 | # Themes 8 | pydata-sphinx-theme~=0.16.1 9 | 10 | # Extensions 11 | sphinx_design~=0.6.1 12 | sphinx-copybutton~=0.5.2 13 | sphinx-favicon~=1.0.1 14 | sphinx-sitemap~=2.6.0 15 | sphinxcontrib-images~=0.9.4 16 | sphinxcontrib-jquery~=4.1 17 | sphinxcontrib-mermaid~=1.0.0 18 | sphinxcontrib-openapi~=0.8.4 19 | sphinxcontrib-spelling~=8.0.1 20 | sphinxcontrib.asciinema~=0.4.2 21 | sphinx-autobuild~=2024.10.3 22 | 23 | # documentation linting 24 | doc8~=1.1.2 25 | 26 | # license check 27 | reuse~=5.0.2 28 | 29 | # autogeneration 30 | ruamel.yaml~=0.18.10 31 | jinja2~=3.1.6 32 | 33 | # linting and formatting 34 | pylint~=3.3.4 35 | black~=25.1.0 36 | yamllint~=1.35.1 37 | 38 | # local files 39 | ./docconf 40 | 41 | # Used by "simple" documentation config 42 | myst-parser~=4.0.1 43 | sphinxcontrib-contentui~=0.2.5 44 | sphinxcontrib-video~=0.4.1 45 | sphinx-tabs~=3.4.7 46 | swagger-plugin-for-sphinx~=5.1.0 47 | 48 | -------------------------------------------------------------------------------- /trivy-secret.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 3 | # SPDX-License-Identifier: Apache-2.0 4 | 5 | allow-rules: 6 | - id: cloud-orch-install 7 | description: Skip example of a private certificate 8 | path: >- 9 | docs/deployment_guide/cloud_deployment/cloud_get_started/cloud_orchestrator_install.rst 10 | -------------------------------------------------------------------------------- /trivy.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: (C) 2025 Intel Corporation 2 | # 3 | # SPDX-License-Identifier: Apache-2.0 4 | 5 | --- 6 | scan: 7 | skip-dirs: 8 | - out 9 | --------------------------------------------------------------------------------