Skip to content
This repository has been archived by the owner on May 27, 2022. It is now read-only.

Latest commit

 

History

History
222 lines (179 loc) · 9.83 KB

flavors.md

File metadata and controls

222 lines (179 loc) · 9.83 KB
SPDX-License-Identifier: Apache-2.0
Copyright (c) 2020 Intel Corporation

Smart Edge Open Deployment Flavors

This document introduces the supported deployment flavors that are deployable through the Converged Edge Experience Kits (CEEK).

Smart Edge Open Experience Kit Minimal Flavor

The pre-defined minimal deployment flavor provisions the minimal set of configurations for bringing up the Smart Edge Open network edge deployment.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.
  2. Update the inventory.yaml file by setting the deployment flavor as minimal 
    ---
all:
  vars:
    cluster_name: minimal_cluster
    flavor: minimal
...
  3. Run CEEK deployment script: 
    $ python3 deploy.py

This deployment flavor enables the following ingredients:

  • Node feature discovery
  • The default Kubernetes CNI: calico
  • Telemetry

To customize this flavor we recommend creating additional file in converged-edge-experience-kits that will override any variables used in previous configuration. This file should be placed in location: converged-edge-experience-kits/inventory/default/group_vars/all and filenames should start with number greater than highest value currently present (e.g. 40-overrides.yml).

Smart Edge Open Experience Kit Access Edge Flavor

Available in Intel Distribution of Smart Edge Open

Smart Edge Open Experience Kit Media Analytics Flavor

The pre-defined media-analytics deployment flavor provisions an optimized system configuration for media analytics workloads on Intel® Xeon® platforms. It also provisions a set of video analytics services based on the Video Analytics Serving for analytics pipeline management and execution.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.
  2. Update the inventory.yaml file by setting the deployment flavor as media-analytics 
    ---
all:
  vars:
    cluster_name: media_analytics_cluster
    flavor: media-analytics
...
  3. Run CEEK deployment script: 
    $ python3 deploy.py

NOTE: The video analytics services integrates with the Smart Edge Open service mesh when the flag ne_istio_enable: true is set. NOTE: Kiali management console username can be changed by editing the variable istio_kiali_username. By default istio_kiali_password is randomly generated and can be retirieved by running kubectl get secrets/kiali -n istio-system -o json | jq -r '.data.passphrase' | base64 -d on the Kubernetes controller. NOTE: Istio deployment can be customized using parameters in the flavor/media-analytics/all.yaml (parameters set in the flavor file override default parameters set in inventory/default/group_vars/all/10-default.yml).

This deployment flavor enables the following ingredients:

  • Node feature discovery
  • The default Kubernetes CNI: calico
  • Video analytics services
  • Telemetry
  • Istio service mesh - conditional
  • Kiali management console - conditional

Smart Edge Open Experience Kit Media Analytics Flavor with VCAC-A

The pre-defined media-analytics-vca deployment flavor provisions an optimized system configuration for media analytics workloads leveraging Visual Cloud Accelerator Card for Analytics (VCAC-A) acceleration.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.

  2. Add the VCA host name in the edgenode_vca_group: group in inventory.yml file of the CEEK, e.g:

    edgenode_vca_group:
  hosts:
    vca-node01.openness.org:
    ansible_host: 172.16.0.1
    ansible_user: openness

    NOTE: The VCA host name should only be placed once in the inventory.yml file and under the edgenode_vca_group: group.

  3. Update the inventory.yaml file by setting the deployment flavor as media-analytics-vca

    ---
all:
  vars:
    cluster_name: media_analytics_vca_cluster
    flavor: media-analytics-vca
...

  4. Run CEEK deployment script:

    $ python3 deploy.py

NOTE: At the time of writing this document, Weave Net* is the only supported CNI for network edge deployments involving VCAC-A acceleration. The weavenet CNI is automatically selected by the media-analytics-vca. NOTE: The flag force_build_enable (default true) supports force build VCAC-A system image (VCAD) by default, it is defined in flavors/media-analytics-vca/all.yml. By setting the flag as false, CEEK will not rebuild the image and re-use the last system image built during deployment. If the flag is true, CEEK will force build VCA host kernel and node system image which will take several hours.

This deployment flavor enables the following ingredients:

  • Node feature discovery
  • VPU and GPU device plugins
  • HDDL daemonset
  • The weavenet Kubernetes CNI
  • Telemetry

Smart Edge Open Experience Kit CDN Transcode Flavor

The pre-defined cdn-transcode deployment flavor provisions an optimized system configuration for Content Delivery Network (CDN) transcode sample workloads on Intel® Xeon® platforms.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.
  2. Update the inventory.yaml file by setting the deployment flavor as cdn-transcode 
    ---
all:
  vars:
    cluster_name: cdn_transcode_cluster
    flavor: cdn-transcode
...
  3. Run CEEK deployment script: 
    $ python3 deploy.py

This deployment flavor enables the following ingredients:

  • Node feature discovery
  • The default Kubernetes CNI: calico
  • Telemetry

Smart Edge Open Experience Kit CDN Caching Flavor

The pre-defined cdn-caching deployment flavor provisions an optimized system configuration for CDN content delivery workloads on Intel® Xeon® platforms.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.
  2. Update the inventory.yaml file by setting the deployment flavor as cdn-caching 
    ---
all:
  vars:
    cluster_name: cdn_caching_cluster
    flavor: cdn-caching
...
  3. Run CEEK deployment script: 
    $ python3 deploy.py

This deployment flavor enables the following ingredients:

  • Node feature discovery
  • The kube-ovn and sriov Kubernetes CNI
  • Telemetry
  • Kubernetes Topology Manager policy: single-numa-node

Smart Edge Open Experience Kit Core Control Plane Flavor

Available in Intel Distribution of Smart Edge Open

Smart Edge Open Experience Kit Core User Plane Flavor

Available in Intel Distribution of Smart Edge Open

Smart Edge Open Experience Kit Untrusted Non3gpp Access Flavor

Available in Intel Distribution of Smart Edge Open

Smart Edge Open Experience Kit Near Edge Flavor

Available in Intel Distribution of Smart Edge Open

Smart Edge Open Experience Kit 5G On-Prem Flavor

Available in Intel Distribution of Smart Edge Open

Central Orchestrator Flavor

Central Orchestrator Flavor is used to deploy EMCO.

The pre-defined orchestration deployment flavor provisions an optimized system configuration for emco (central orchestrator) workloads on Intel Xeon servers. It also provisions a set of central orchestrator services for edge, multiple clusters orchestration.

The following are steps to install this flavor:

  1. Configure the CEEK as described in the Smart Edge Open Getting Started Guide for Network Edge.
  2. Update the inventory.yaml file by setting the deployment flavor as central_orchestrator 
    ---
all:
  vars:
    cluster_name: central_orchestrator_cluster
    flavor: central_orchestrator
...
  3. Run CEEK deployment script: 
    $ python3 deploy.py

This deployment flavor enables the following ingredients:

  • Harbor Registry
  • The default Kubernetes CNI: calico
  • EMCO services