summaryrefslogtreecommitdiffstats
path: root/agl-documentation/host-configuration/docs/0-build-microservice-overview.md
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-03-02 23:02:15 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-03-02 23:02:15 +0100
commitaa9912660e08f8d406e74807bab476cc60dd9581 (patch)
tree0ae6224559314904492033378795bd21b96623d6 /agl-documentation/host-configuration/docs/0-build-microservice-overview.md
parent4e7e82a279ffa322f31e0dfee8a4bad370878753 (diff)
Add agl-documentation subfolder into agl repo
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'agl-documentation/host-configuration/docs/0-build-microservice-overview.md')
-rwxr-xr-xagl-documentation/host-configuration/docs/0-build-microservice-overview.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/agl-documentation/host-configuration/docs/0-build-microservice-overview.md b/agl-documentation/host-configuration/docs/0-build-microservice-overview.md
new file mode 100755
index 0000000..57d7981
--- /dev/null
+++ b/agl-documentation/host-configuration/docs/0-build-microservice-overview.md
@@ -0,0 +1,55 @@
+# Overview
+
+You can develop Microservices on your native Linux machine quickly
+by following the workflow in this section.
+This workflow takes advantage of RPM or Debian packages,which are available
+through the
+[OpenSUSE Build Service (OBS)](https://build.opensuse.org/).
+You can install these
+[packages](https://build.opensuse.org/project/subprojects/isv:LinuxAutomotive)
+and bypass the
+[Yocto Project](https://yoctoproject.org) build cycles described in the
+"[Developing an AGL Image](../../getting_started/reference/getting-started/image-workflow-intro.html)" section.
+
+Using this workflow, you can start to code, execute, and debug Microservice
+bindings directly on your host. This flow works for many cases for which
+no specific hardware is required, or when you can plug hardware directly
+into your native Linux host's USB port such as a Controller Area Network
+([CAN](https://en.wikipedia.org/wiki/CAN_bus)) bus Adapter or a Media
+Oriented Systems Transport
+([MOST](https://en.wikipedia.org/wiki/MOST_Bus)) Controller.
+
+The following figure and list overview the Microservice Native Development
+process.
+You can learn about the steps in the process by reading through the
+remaining sections.
+
+<center><img src="pictures/microservice-workflow-native.png"></center>
+
+1. **Verify Your Build Host:**
+ Make sure you have a native Linux host.
+ For the example used in this section (i.e. `helloworld-service`), be sure your
+ Linux distribution is a recent version of Debian, Ubuntu, OpenSUSE, or Fedora.
+
+2. **Download and Install AGL Packages:**
+ Download and install the
+ [near-zero](https://en.wikipedia.org/wiki/Zero_Install) packages
+ from the OBS.
+
+3. **Install the Binder Daemon:**
+ Install the Binder Daemon, which is a part of the
+ [AGL Application Framework (AFM)](../../apis_services/reference/af-main/0-introduction.html).
+ The daemon allows you to connect applications to required services.
+
+4. **Get Your Source Files:**
+ For this section, you clone the `helloworld-service` binding repository.
+ You also need to make sure you have some other required packages to build
+ that specific binding.
+
+5. **Build and Run Your Service Natively (Optional Tool Use):**
+ Build your binding on your Linux host using native tools.
+ Once the binding is built, you can run it to make sure it functions
+ as expected.
+
+ Optionally use extra tools once your binding is building and running
+ smoothly in the native environment.