Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add docs on remote deployments multiple device services in secure #1278

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ajcasagrande
Copy link
Contributor

@ajcasagrande ajcasagrande commented Nov 1, 2023

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README)

Changes have been rendered, but some of the notes and code snippets do not seem to be rendered correctly. Any advice or guidance would be appreciated. Thanks!

@lenny-goodell
Copy link
Member

@ajcasagrande , PR #1279 moves the location of the remote deployment docs. We'll have conflict depending on which PR is merged first ;-)

Copy link
Contributor

@presatish presatish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general lot of numbering issues, some typos, notes are not rendered properly so need some change and also some have location links but many others don't.

docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
docs_src/microservices/device/remote/Ch-RemoteSecure.md Outdated Show resolved Hide resolved
@ajcasagrande
Copy link
Contributor Author

@lenny-intel @presatish ready for re-review

Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice Job! Just a few minor tweaks.


## Example
This example uses 3 nodes for remote deployment. One of the nodes (host) is used to run all EdgeX core services in Docker and the other nodes (remote)
for running the device-usb-camera service in Docker. This example can be further extended to run multiple instances of device-usb-camera
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

per " This example can be further extended to run multiple instances of device-usb-camera
service in multiple nodes."

Are you do that in this example with 2 remote nods each running Device USB Camera?

edgex and usb services
- Local and remote nodes needs to be on the same network

!!! Note
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it has to be lower case to render properly. Please verify.

Suggested change
!!! Note
!!! note

Comment on lines +247 to +248
!!! example
=== "Remote Node 1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
!!! example
=== "Remote Node 1"
!!! example - "Remote Node 1"

- /run/udev:/run/udev:ro
```

=== "Remote Node 2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
=== "Remote Node 2"
!!! example - "Remote Node 2"

- /run/udev:/run/udev:ro
```

=== "Remote Node Template"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
=== "Remote Node Template"
!!! example - "Remote Node Template"


## Pre-requisites
- 3 machines running Ubuntu 20.04 or newer OS, with docker installed.
- 1 `local` system for deploying all edgex core services in secure mode with docker
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 1 `local` system for deploying all edgex core services in secure mode with docker
- 1 `local` system for deploying all EdgeX core services in secure mode with docker

- 1 `local` system for deploying all edgex core services in secure mode with docker
- 2 `remote` nodes for deploying USB service in secure mode with docker
- All dependencies such as docker, git, curl etc. installed on all 3 systems to run
edgex and usb services
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
edgex and usb services
EdgeX and usb services

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants