Skip to content

Commit

Permalink
More TODOs and light edits
Browse files Browse the repository at this point in the history
Added more TODOs and removed more Darcy branding. Had also edited some of he text that was no longer applicable.
  • Loading branch information
ag-edge committed Jul 18, 2023
1 parent ff860d6 commit 9a9dc2b
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 36 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/cloud/access-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 800
aliases:
- /darcy/darcy-cloud/access-tokens
---

<!-- TODO: Replace screenshots and code snippets -->
Edgeworx Cloud supports basic HTTP authentication through access tokens.

Simply pass the token as username in
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/cloud/adding-nodes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ Edgeworx Cloud is compatible with many Linux edge boards, such as:
- Debian 10+

{{<info>}}
If you don't have any edge hardware yet, you can create a [virtual node](/docs/cloud/adding-nodes/virtual-node.md) using Edgeworx Cloud, create a VM in the Cloud, or a [Vagrant](https://www.vagrantup.com) image running on your laptop and run
If you don't have any edge hardware yet, you can create a [virtual node](/docs/cloud/adding-nodes/virtual-node.md) using Edgeworx Cloud, create a VM in the Cloud, a [Vagrant](https://www.vagrantup.com) image running on your device, or whatever virtualization software, and run
the node installation script.
{{</info>}}
34 changes: 17 additions & 17 deletions content/en/docs/cloud/adding-nodes/add-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ weight: 400
aliases:
- /darcy/darcy-cloud/get-started-ec/nodes/get-started-add-node
---

<!-- TODO: Replace screenshots -->
To add a [node](../adding-nodes/_index.md) to your [project](/docs/more/terminology#project), you will be running a command line script. For this we assume you
have ssh or console access to your node and are using a common shell, such as zsh or bash.
Additionally, the installation script by default will need to run as sudo to register the necessary
services to be automatically started after the node is rebooted.

Add nodes using the Darcy Portal UI or terminal commands via [edgectl](../edgectl)
Add nodes using the Edgeworx Portal UI or terminal commands via [edgectl](../edgectl)

## Add a node using Darcy Cloud Portal
## Add a node using Edgeworx Cloud Portal

### Get the node Install script

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

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

Expand Down Expand Up @@ -44,11 +44,11 @@ speed, and other dependencies).

{{<info>}}
If you would like to choose a specific name for your node, use the
variable `DARCY_NODE_NAME="your-choice-of-name"` in the _node install script_
variable `Edgeworx_NODE_NAME="your-choice-of-name"` in the _node install script_
as in the example below.
{{</info>}}

### View the node in Your Darcy Cloud Project
### View the node in Your Edgeworx Cloud Project

Switch back to your browser 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. If you do not see your node online, check our
Expand All @@ -60,7 +60,7 @@ You now have an edge node, let's start using it!

## Add a node using edgectl

In [Darcy Cloud](/docs/cloud/start-portal), nodes are edge devices that run Edgeworx Agents. Ultimately, we want to deploy
In [Edgeworx Cloud](/docs/cloud/start-portal), nodes are edge devices that run Edgeworx Agents. Ultimately, we want to deploy
[applications](/docs/more/terminology#application) to these nodes to put them to work.

If we list nodes in our default [organization](/docs/more/terminology#account--org) and project, we will notice that we have no nodes:
Expand All @@ -74,10 +74,10 @@ shell snippet that you can execute on the node:

```bash
$ edgectl get node-register-script -t
curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.darcy.ai/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.edgeworx.io/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
```

We can use this shell snippet on our edge devices to install Edgeworx Agent and connect to our Darcy
We can use this shell snippet on our edge devices to install Edgeworx Agent and connect to our Edgeworx
Cloud Project. This command can be used any number of times on different devices to grow the
respective project's node pool.

Expand All @@ -95,7 +95,7 @@ First, get the node-install-script shell snippet, and copy it to the clipboard:

```bash
$ edgectl get node-install-script -t
curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.darcy.ai/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.edgeworx.io/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
```

Then `SSH` into your node (in this case, a Raspberry Pi):
Expand All @@ -110,10 +110,10 @@ pi@raspberrypi:~ $
```
Then paste the node install script shell snippet at the Pi terminal. This installs the necessary
Darcy Cloud components, and connects your node to Darcy Cloud.
Edgeworx Cloud components, and connects your node to Edgeworx Cloud.
```bash
pi@raspberrypi:~ $ curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.darcy.ai/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
pi@raspberrypi:~ $ curl -s https://ecj_vfsw9wess5kheafxaeaeh2kskkv301e9f0ip@api.edgeworx.io/v1/project/b75676cb-ae3f-4808-a992-0811e077d783/node-install-script | sudo bash
Installing Edgeworx Agent
1 Initializing
✔ Package manager updated
Expand Down Expand Up @@ -144,7 +144,7 @@ Installing Edgeworx Agent
∙ Storage: 9.5G/118G (9%)
5 Installing services
▶ Edgeworx agent
Darcy Cloud Node created
Edgeworx Cloud Node created
✔ GPG found
✔ Edgeworx Agent installed
▶ Deviceplane
Expand All @@ -159,12 +159,12 @@ Installing Edgeworx Agent
✔ ioFog Agent registered
✔ ioFog Agent provisioned
6 SUCCESS
✔ You can view this Agent in your Darcy Cloud project here: https://cloud.darcy.ai/alice/edge-project-1/node/raspberrypie1c0fe7939883f228946
✔ You can view this Agent in your Edgeworx Cloud project here: https://cloud.edgeworx.io/alice/edge-project-1/node/raspberrypie1c0fe7939883f228946
✔ To uninstall, execute `sudo /opt/edgeworx/uninstall.sh`
```
Note the final two lines: The first line provides a link to view your node in the Darcy Cloud web
portal. The final line provides a command to uninstall the software and detach the node from Darcy
Note the final two lines: The first line provides a link to view your node in the Edgeworx Cloud web
portal. The final line provides a command to uninstall the software and detach the node from Edgeworx
Cloud.
Now that we have our node connected to Darcy Cloud, we can install an application to that node.
Now that we have our node connected to Edgeworx Cloud, we can install an application to that node.
24 changes: 12 additions & 12 deletions content/en/docs/cloud/adding-nodes/virtual-node.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: "Add a Virtual Node"
description: "Add a Virtual Node (lightweight local VM) to Darcy Cloud"
description: "Add a Virtual Node (lightweight local VM) to Edgeworx Cloud"
weight: 450
---

Typically you want to push your apps to a "real edge board" (such as a Raspberry Pi with AI accelerator attached).
<!-- TODO: Redo screenshots -->
Typically you want to push your apps to a "real edge board".
However, if you do not have an edge board to test on, you can simulate one using the Virtual Node feature.

Adding a Virtual Node sets up a new Ubuntu VM locally and registers it as a node to a Darcy Cloud project
via the edgectl CLI. macOS and Windows users can create Virtual Nodes using Darcy Cloud Portal and
Adding a Virtual Node sets up a new Ubuntu VM locally and registers it as a node to a Edgeworx Cloud project
via the edgectl CLI. macOS and Windows users can create Virtual Nodes using Edgeworx Cloud Portal and
edgectl. Linux users can directly use the Register Node command on their terminal.

### Prerequisites

- [Darcy Cloud Account (Free)](https://cloud.darcy.ai)
- [Edgeworx Cloud Account (Free)](https://cloud.edgeworx.io)
- Install [edgectl CLI]({{<ref "/docs/cloud/edgectl/">}})
- Install [Multipass](https://multipass.run): it is used by edgectl to manage VMs.

Expand All @@ -23,7 +23,7 @@ You can still build locally using attached video and deploy to edge devices with

## Get the Virtual Node Installation Script

Log into [Darcy Cloud](https://cloud.darcy.ai) and select the project to which you want to add the
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)
Expand All @@ -40,7 +40,7 @@ Choose `VIRTUAL NODE` to get the instructions for adding a virtual node.
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
your clipboard. This command starts an Ubuntu VM which registers
itself with Darcy Cloud as a Virtual Node.
itself with Edgeworx Cloud as a Virtual Node.

## Run the Virtual Node Registration Script

Expand All @@ -54,9 +54,9 @@ connection speed, and other dependencies).
the `--name="your-choice-of-name"` in the _edgectl create virtual-node_ command as seen in the above
example. {{</info>}}

## View the Node in Your Darcy Cloud Project
## View the Node in Your Edgeworx Cloud Project

Switch back to Darcy Cloud in your browser and if you have not done so yet, click the `DONE` button
Switch back to Edgeworx Cloud in your browser 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. If you do not see
your node online, see troubleshooting (below) for more information.

Expand All @@ -76,7 +76,7 @@ that all the resources used are cleaned up properly i.e. Ubuntu VM.
We can modify the default values based on our Windows machine spec. For example:

```bash
edgectl create virtual-node --name=darcy-node --cpus 2
edgectl create virtual-node --name=Edgeworx-node --cpus 2
```

Below are the default values used to spin up a multipass VM.
Expand All @@ -100,7 +100,7 @@ Use `multipass ls` to retrieve the correct IP.
</details>
<details>
<summary>Use <code>edgectl delete virtual-node</code> in favor of <code>edgectl delete node</code>.</summary>
The <code>edgectl delete node</code> command deletes the node from Darcy Cloud, but does not delete the local VM.
The <code>edgectl delete node</code> command deletes the node from Edgeworx Cloud, but does not delete the local VM.
Use <code>edgectl delete virtual-node</code>
to delete both the node and the local VM.
</details>
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/cloud/deploy-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
aliases:
- /darcy/darcy-cloud/get-started-edgectl/deploy-an-app
---

<!-- TODO: Replace screenshots -->
Deploy apps using the Edgeworx Portal UI or terminal commands via [edgectl](../cloud/edgectl)

#### Prerequisites
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/cloud/edgectl/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ aliases:
- /docs/cloud/edgectl
- /docs/cloud/get-started-edgectl
---

<!-- TODO: Need to include orgs and name change on all commands -->
_edgectl_ is [Edgeworx Cloud's](/docs/cloud/start-portal) command line interface (CLI). It can be used to manage Edgeworx
Cloud
[accounts, organizations,](/docs/more/terminology/#account--org) [projects](/docs/more/terminology#project), [nodes](/docs/cloud/adding-nodes),
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/cloud/start-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ aliases:
Navigate to [Edgeworx Cloud](https://cloud.darcy.ai/welcome) using your browser (Chrome, Firefox,
and Safari preferred- other browsers are not thoroughly maintained) and click the `Create Account`
button.

<!-- TODO: Re-do screenshots -->
<!-- TODO: Include instructional for GCM paid users. -->
<!-- TODO: Redo content to reflect new dashboard -->
![Edgeworx Cloud Welcome Page](/images/cloud-home.png)

Enter your unique username and click `NEXT`.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ cards:
time: Easy
link: '/docs/guides/deploy/'
image: /images/guides/guide-thumb-deploy.jpg
-
---
{{< cards >}}
4 changes: 2 additions & 2 deletions content/en/docs/guides/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This guide was created using an Raspberry Pi 4, however you can use any device w
### Software Requirements

- Docker Desktop and a Docker account
- Edgeworx Cloud account (Free)
- Edgeworx Cloud account (Free or paid)

### Hardware Requirements

Expand Down Expand Up @@ -65,7 +65,7 @@ Make sure you create the Dockerfile in the same
directory as your Python file and change the name below from YOURFILE.py to the actual name of your
file.
{{</warning>}}
<!-- TODO This needs to be completely redone -->
<!-- TODO This needs to be completely redone. Maybe with Docker's Hello World? -->
```text
FROM darcyai/darcy-ai-coral:dev
Expand Down

0 comments on commit 9a9dc2b

Please sign in to comment.