Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ the Edgeworx Cloud platform to connect to one or more edge nodes. Apps are defin
and can be deployed and updated by uploading those YAML files. Edgeworx nodes can be set up to interact
with applications, process information, and move data between multiple apps.

![Application view in the Edgeworx Cloud platform](</images/image (12).png>)
![Application view in the Edgeworx Cloud platform](</images/apps_full.png>)

## Application Components

Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/apps/demo-apps/heart-rate.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ follow the steps below:
5. Select the node(s) where you want it to run
6. Click `DEPLOY`

![Application Deployment Page](/images/12done.png)
![Application Deployment Page](/images/heart_rate_app_modal.png)

## See Application Results

Expand All @@ -47,12 +47,12 @@ right of your screen.
If you are not already seeing the app listed, click the `APPS` tab to see all of the apps in your
current project. Click the app to access the app detail view.

![Project Details View](/images/13done.png)
![Project Details View](/images/deployed_app.png)

From the app detail view, click the linked text under the `ports` column to navigate to the app
output.

![Application Detail View](/images/14done.png)
![Application Detail View](/images/app_details.png)

You should be brought to the Heart Rate Demo App.

Expand Down Expand Up @@ -81,7 +81,7 @@ spec:
data_label: Anonymous Person
- name: viewer
agent:
name: virtual-node-alexpc
name: nodename
images:
arm: 'edgeworx/heart-rate-demo-viewer:1.0.0'
x86: 'edgeworx/heart-rate-demo-viewer:1.0.0'
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ thoughtful REST APIs and opinionated (and extensible) YAML specs for software de
integration with today’s most popular developer tools and workflows. If you know how to use
Terraform or Kubernetes then you'll be immediately at home with Edgeworx Cloud.

![Projects Overview](/images/portal-projects-overivew-luckyspin.jpg)
![Projects Overview](/images/project_view_remote.png)

### Features

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/cloud/access-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ https://<access_token>@api.edgeworx.io/v1/...

```text
window.fetch(
"https://api.edgeworx.io/v1/account/cypress%40edgeworx.io",
"https://api.edgeworx.io/v1/account/penny.lim@edge-ample.io",
{ headers:
{ Authorization: "Basic " + window.btoa("<access_token>:")}
}
Expand All @@ -43,14 +43,14 @@ edgectl --token <access_token> account get <your_email>
Personal Access Tokens have the same privilege as the user they represent and have a lifecycle
connected to the user account.

![Personal Access Tokens](</images/image (23).png>)
![Personal Access Tokens](</images/access_token_modal.png>)

### Project Access Token

[Project](../more/terminology#project) Access Tokens have full access to the project they represent and have a lifecycle connected
to their project. Those are the token used in the [node register script](../more/terminology#node-install-script).

![Project Access Token](</images/image (29).png>)
![Project Access Token](</images/project_access_token_modal.png>)

### Third Party Access Tokens

Expand Down
48 changes: 24 additions & 24 deletions content/en/docs/cloud/adding-nodes/add-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ Add nodes using the Edgeworx Portal UI or terminal commands via [edgectl](../edg

Log into [Edgeworx Cloud](https://cloud.edgeworx.io) and select the project you want to [add the node](../../more/terminology#node-register-script).

![Add Node](/images/add-node.png)
![Add Node](/images/project_view_empty_sandbox.png)

Click the `+ ADD NODE` button. This will bring up a modal dialog which shows all the types of nodes you could add in your project.

![Register Node Script](/images/select-node-type.png)
![Register Node Script](/images/node_modal.png)

Click on `EDGE NODE`. This will bring up a modal dialog which shows the one line command that must be run on your
host for it to become a node in your edge project.

![Register Node Script](/images/add-edge-node.png)
![Register Node Script](/images/node_modal_script.png)

Click the `COPY` button to copy the install command to your clipboard.

Expand All @@ -40,7 +40,7 @@ The entire install
process can take up to a few minutes (depending on the spec of your node, your internet connection
speed, and other dependencies).

![Install Node](/images/edge-node-added.png)
![Install Node](/images/node_script_terminal.png)

{{<info>}}
If you would like to choose a specific name for your node, use the
Expand All @@ -53,7 +53,7 @@ as in the example below.
Switch back to your project and if you have not done so yet, click the `DONE` button in the modal dialog. You
should see your new node `ONLINE` in your nodes list.

![Node Added](/images/1st-node-added.png)
![Node Added](/images/project_view_sandbox_firstnode.png)

## Add a node using edgectl

Expand Down Expand Up @@ -89,43 +89,43 @@ This is helpful if you wish to review or debug the installation procedure.
As the register script runs, you will see it's progress as it install dependencies.

```bash
pi@raspberrypi:~ $ curl -s https://ecj_vfsdasdasdxaeaeh2kskkv301e9f0ip@api.edgeworx.io/v1/project/b7asdasdas-e3f-4808-a992-0811e077d783/node-register-script | sudo bash
pi@raspberrypi:~ $ curl -s https://ecj_usert0ken@api.edgeworx.io/v1/project/pr0jectuuid/node-register-script | sudo bash
Installing Edgeworx Agent
1 Initializing
✔ Package manager updated
2 Performing preflight checks
▶ Checking for dependencies
✔ curl found
✔ jq found
✔ java found
✔ docker found
✘ jq not found
✘ java not found
✘ docker not found
▶ Installing dependencies: jq
✔ jq installed
3 Verifying node state
✔ Detected Linux distribution: debian
! Adding this node to a new project will leave a dangling node in the old project: neil/proj1/raspberrypi14511447b32329f25b77.
! Make sure to migrate any microservices that were running on it, then delete it. E.g. `edgectl node remove neil/proj1/raspberrypi14511447b32329f25b77`
✔ Node name raspberrypie1c0fe7939883f228946 is valid
✔ Node name raspberrypie1c0fe7939883f228946 is available
✔ Detected Linux distribution: ubuntu
✔ Node name myfirstnode265dedacfa9961ab3b2a is valid
✔ Node name myfirstnode265dedacfa9961ab3b2a is available
✔ Node is ready for installation
4 System finger print
▶ Shell
∙ Exec: /bin/bash
∙ User: root
▶ Host
∙ Hostname: raspberrypi
∙ OS Release: Debian GNU/Linux 11 (bullseye)
∙ Kernel: Linux raspberrypi 5.10.94-v8+ #1518 SMP PREEMPT Thu Jan 27 14:55:19 GMT 2022 aarch64 GNU/Linux
∙ Hostname: MyFirstNode
∙ OS Release: Ubuntu 22.04.3 LTS
∙ Kernel: Linux MyFirstNode 5.15.0-87-generic #97-Ubuntu SMP Mon Oct 2 21:09:21 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
▶ System
∙ CPUs: 4
∙ Memory: 5.5Gi
∙ Storage: 9.5G/118G (9%)
∙ CPUs: 1
∙ Memory: 130Mi
∙ Storage: 1.7G/4.7G (35%)
5 Installing services
▶ Edgeworx agent
Edgeworx Cloud Node created
▶ Edgeworx Agent
Node registered with Edgeworx Cloud
✔ GPG found
✔ Edgeworx Agent installed
▶ Deviceplane
✔ Deviceplane Agent registered
✔ Deviceplane Agent configured
✔ Deviceplane Agent installed
▶ ioFog Agent
✔ Scripts downloaded
✔ Ready to install
Expand All @@ -135,7 +135,7 @@ Installing Edgeworx Agent
✔ ioFog Agent registered
✔ ioFog Agent provisioned
6 SUCCESS
✔ You can view this Agent in your Edgeworx Cloud project here: https://cloud.edgeworx.io/alice/edge-project-1/node/raspberrypie1c0fe7939883f228946
✔ You can view this Agent in your Edgeworx Cloud project here: https://cloud.darcy.ai/pennylim/sandbox/node/myfirstnode265dedacfa9961ab3b2a
✔ To uninstall, execute `sudo /opt/edgeworx/uninstall.sh`
```

Expand Down
13 changes: 8 additions & 5 deletions content/en/docs/cloud/adding-nodes/virtual-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ You can still build locally using attached video and deploy to edge devices with
Log into [Edgeworx Cloud](https://cloud.edgeworx.io) and select the project to which you want to add the
node.

![Add Virtual Node](/images/add-node.png)
![Add Virtual Node](/images/project_view_empty_sandbox.png)

Click the `+ ADD NODE` button. This will bring up a modal dialog which shows the different types of
nodes you can add to your project.

![Portal: Select Virtual Node](/images/select-virtual-node.png)
![Portal: Select Virtual Node](/images/node_modal.png)

Choose `VIRTUAL NODE` to get the instructions for adding a virtual node.

![Virtual Node Script](/images/add-virtual-node.png)
![Virtual Node Script](/images/node_modal_vn_script.png)

Make sure you have the latest versions of [edgectl]({{<ref "/docs/cloud/edgectl/">}})
and [Multipass](https://multipass.run) installed. Click the `COPY` button to copy the command to
Expand All @@ -50,7 +50,7 @@ Paste the command line that you copied in the previous step into your local term
process can take up to a few minutes (depending on the spec of your machine, your internet
connection speed, and other dependencies).

![Install Node](/images/virtual-node-added.png)
![Install Node](/images/virtual_node_script_terminal.png)

{{<info>}} If you would like to choose a specific name for your node, update
the `--name="your-choice-of-name"` in the _edgectl create virtual-node_ command as seen in the above
Expand All @@ -62,7 +62,7 @@ Switch back to Edgeworx Cloud in your browser and if you have not done so yet, c
in the modal dialog. You should see your new node `ONLINE` in your Nodes list. If you do not see
your node online, see troubleshooting (below) for more information.

![Node Added](/images/virtual-node-portal-view.png)
![Node Added](/images/project_view_sandbox_vn.png)

You now have an edge node, let's start using it!

Expand Down Expand Up @@ -92,6 +92,9 @@ You can use Multipass' flags in edgectl to control the amount of memory, CPU cor
We recommend using `edgectl delete virtual-node` command to delete the Virtual Node after use, so
that all the resources used are cleaned up properly i.e. Ubuntu VM.

{{<warning>}} Deleting Virtual Nodes in the Portal will require you delete the virtual machines manually where ever they are hosted. Using `edgectl delete virtual-node <nameofnode>` or `multipass delete <nameofvm>` on the host machine will delete the virtual machine.
{{</warning>}}

## Troubleshooting

<details>
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/cloud/deploy-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ of [how to structure app YAML]({{<ref "/docs/apps/yaml-definition.md">}}) for Ed
3. Click on `+ DEPLOY APP`
4. Drag n' drop a [YAML file]({{<ref "/docs/apps/yaml-definition.md">}}) into the box

![Application Deployment Page](/images/cloud-deploy-demo.png)
![Application Deployment Page](/images/app_select.png)

### View your Application Details

Click on your app in the list of [applications](../more/terminology#application) to see its details.

![Application Detail View](/images/18done.png)
![Application Detail View](/images/app_details.png)

The app details page contains information about its [microservices](../apps/microservices.md), routes, the nodes
involved in running the microservices and its YAML Definition.
Expand Down Expand Up @@ -80,7 +80,7 @@ e.g. `edgectl get app edgeworx-heart-rate --json`: (output abbreviated for clari
"id": 1,
"isActivated": true,
"name": "edgeworx-heart-rate",
"projectUUID": "b75676cb-ae3f-4808-a992-0811e077d783",
"projectUUID": "pr0jectuuid",
"routes": [
{
"from": "monitor",
Expand All @@ -98,8 +98,8 @@ Use `edgectl get microservices`:
```bash
$ edgectl get microservices --app edgeworx-heart-rate
NAME STATUS IMAGE NODE
monitor RUNNING edgeworx/healthcare-heart-rate:arm-v1 raspberrypie1c0fe7939883f228946
viewer RUNNING edgeworx/healthcare-heart-rate-ui-arm:1.0.0 raspberrypie1c0fe7939883f228946
monitor RUNNING edgeworx/healthcare-heart-rate:arm-v1 west-sf-rnd2346fadc292082f70ed0
viewer RUNNING edgeworx/healthcare-heart-rate-ui-arm:1.0.0 west-sf-rnd2346fadc292082f70ed0
```

To view the details of the `monitor` microservice in the `edgeworx-heart-rate` app:
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/cloud/node-remote-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ and `ONLINE` and some knowledge of `SSH` commands.

In the portal, click on any node to access the node's detail page.

![Node Detail Page](/images/7done.png)
![Node Detail Page](/images/app_details_empty.png)

From here, click on the `SSH` button. This will open a new tab in your browser, after a small
loading time, you'll have access to a terminal on your node.

![SSH Terminal Page](</images/Screen Shot 2022-04-08 at 1.36.50 PM.png>)
![SSH Terminal Page](</images/ssh_terminal_cropped.png>)

{{<info>}}You can also access the SSH shortcut from the [project](/docs/more/terminology#project) overview page by
clicking the 3 dots to the right of your node and selecting `SSH` from the drop down menu.
Expand Down
20 changes: 7 additions & 13 deletions content/en/docs/cloud/orgs-and-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ you first sign up). You will then be guided through creation. The only required

![Org Create Screen](/images/orgs/org-create.png)

![Org Create Details Screen](/images/orgs/org-create-details.png)
![Org Create Details Screen](/images/create_org_modal.png)

![Org Details Screen](/images/orgs/org-details.png)
![Org Details Screen](/images/dashboard_org_details.png)

## Invite members

Expand Down Expand Up @@ -62,11 +62,7 @@ members into the org by email.
![Org Member Invite Screen](/images/orgs/org-member-invite.png)

If you need to invite more members, you can do so through the member details screen.
Navigate to the org page, and click invite to invite a new member by their email.

![Org Details Screen](/images/orgs/org-details.png)

![Org Member Invite Screen](/images/orgs/org-member-invite.png)
Navigate to the org page, and click `INVITE MEMBER` to invite a new member by their email.

## Accept invite

Expand Down Expand Up @@ -104,7 +100,7 @@ UUID NAME PERSONAL ORG CREATED UTC SCOPES
You should receive an email with directions on how to accept an org invite. Follow
the instructions to create an account and accept the invite to the new org.

![Org Member Invite Email](/images/orgs/org-member-invite-email.png)
![Org Member Invite Email](/images/verification_email.png)

## Modify member scopes

Expand All @@ -123,9 +119,9 @@ Updated scopes on account {bob} in org {15e23cf5-c4f7-4ac9-aedb-689231124f10|acm
In the Cloud Portal, navigate to the org page, click the settings wheel next to the "members" header,
and select the permission you want to change for a user.

![Org Member Details](/images/orgs/org-member-details.png)
![Org Member Details](/images/org_details_members.png)

![Change Member Permissions](/images/orgs/org-member-change-permissions.png)
![Change Member Permissions](/images/org_details_members_perm.png)

## Remove member

Expand All @@ -143,6 +139,4 @@ edgectl delete member --org acme --account bob
In the Cloud Portal, navigate to the org page, click the settings wheel next to the "members" header,
and remove the user with the "delete" icon next to the user's email.

![Org Member Details](/images/orgs/org-member-details.png)

![Remove Member](/images/orgs/org-member-remove.png)
![Remove Member](/images/org_member_delete_modal.png)
8 changes: 4 additions & 4 deletions content/en/docs/guides/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: "Deploy to the edge"
weight: 250
---

![Edgeworx CLoud Project Page](/images/guide4-deploy-cloud.jpg)
![Edgeworx CLoud Project Page](/images/project_view.png)

## What you will accomplish

Expand Down Expand Up @@ -48,7 +48,7 @@ at [https://cloud.edgeworx.io](https://cloud.edgeworx.io).
Once you are in your Edgeworx Cloud account, choose your Sandbox or a [project](/docs/more/terminology#project) nested in an Org, and [add your device as a node](/docs/cloud/adding-nodes/add-node.md) using the `+ ADD NODE` button. Follow the instructions in the pop-up window to
continue with either a virtual node or physical device.

![Cloud Portal Plus Button](/images/guides/deploy-node-ui.gif)
![Cloud Portal Plus Button](/images/project_empty.png)

### Create your application YAML

Expand Down Expand Up @@ -94,11 +94,11 @@ in the steps above.

Now that you have all of the pieces, it's easy to deploy your application to your device. In the project where the target device is located, open the `APPS` tab and click `+ DEPLOY APP` and follow the instructions in the pop up.

![Deploy app animation](/images/guides/deploy-app-ui.gif)
![Deploy app animation](/images/app_select.png)

In the pop-up window, choose the `UPLOAD YOUR APP` option and you can drag and drop your YAML file into that window or upload it.

![Deploy App](/images/guides/deployAnApp.PNG)
![Deploy App](/images/app_details.png)

Edgeworx Cloud will notify you if there are issues with the YAML file or your app deployment. Once deployed, you can monitor the image or images being pulled and their status once it is running.

Expand Down
Loading