Skip to content

Latest commit

 

History

History
98 lines (53 loc) · 5.72 KB

developer_learning_path.md

File metadata and controls

98 lines (53 loc) · 5.72 KB
copyright years lastupdated layout title description parent nav_order
2021 - 2023
2023-02-26
page
Developer learning path
A set of sequential resources for the developer learning about Open Horizon
Quick Start
5

Edge developer learning path

This is a set of resources compiled from new developers who have found them to be useful. If you have any proposed improvements, please open an issue {:target="_blank"}{: .externalLink} and suggest it.

Resources to learn more about the Open Horizon components

The following set of resources consisting of links to past Open Horizon meetings, videos and readme sections are useful to get started with the various segments of the Open Horizon project (excluding the SDO-services and Edge Sync Service).

  1. Introduction:

    a. Get an idea of what Open Horizon is all about from https://www.lfedge.org/projects/openhorizon/ {:target="_blank"}{: .externalLink}

    b. Introductory videos by OH member Glen Darling

    1. An overview of Open Horizon - video {:target="_blank"}{: .externalLink}.

    2. More technical details - video {:target="_blank"}{: .externalLink}.

    c. An overview of the Agent's role in OH - First meeting recording {:target="_blank"}{: .externalLink} of the Agent WG.

    d. Another descriptory video from the meeting recording {:target="_blank"}{: .externalLink} of the QA Working Group.

  2. Services, policies and patterns (Important)

    a. Glen’s introductory video {:target="_blank"}{: .externalLink} on patterns and policies.

    b. An introduction {:target="_blank"}{: .externalLink} to services.

    c. Service networking {:target="_blank"}{: .externalLink} demo.

  3. Getting started:

    a. Get started {:target="_blank"}{: .externalLink} with contributing to Anax.

    b. Helpful installation guides from the docs

    1. Install and setup environment

    2. How to use.

    c. Using the all-in-one deployment (for the hands on practicals next)

    1. Recording {:target="_blank"}{: .externalLink} from the Management Hub WG.

    2. Readme guide.

    d. Hands on practical

    1. Demo {:target="_blank"}{: .externalLink} - without policies.

    2. Advanced {:target="_blank"}{: .externalLink} - deploying with patterns vs policies.

    3. Glen's Easy Open Horizon repository {:target="_blank"}{: .externalLink}.

  4. Useful references

    a. Setup {:target="_blank"}{: .externalLink} e2edev test environment

    b. Create {:target="_blank"}{: .externalLink} your own service.

    c. Deploy {:target="_blank"}{: .externalLink} your own service.

    d. Get started {:target="_blank"}{: .externalLink} with contributions to exchange-api.

Sequential tasks to gradually introduce you to common features

Here is a suggested list that is designed to progressively create familiarity with all of the common features of the Open Horizon platform.

  1. Get started: Install all-in-one

  2. Get familiar: unregister node, re-register node, (optionally add a node), publish an example service

  3. Get published: Create a service definition file for an existing container and publish it to the exchange, then register your node for the service.

  4. Get containerized: Take an existing (micro-)service and turn it into a Docker container, then publish and register.

  5. Get patterned: Compose a pattern definition file of several existing services, publish, register.

  6. Make policy: Create/modify your node policy file and publish to exchange. Create a business/deployment policy and confirm that agreement made and service deployed.

  7. Operator? If you have a cluster available, make an operator to deploy your service using Glen's Operator Helper.

  8. In Sync: Get the sync service to sync a hello world file.

  9. Sync Squared: Using Glen's MMS Helper, modify a service to watch for a file dependency to be updated.