docs: remote deployment example (device-usb-camera) added #1211
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
presatish
requested review from
lenny-goodell,
ajcasagrande,
vyshali-chitikeshi and
seanohair22
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
seanohair22
suggested changes
Sep 6, 2023
| The deployment can be done by running the service `natively` or by running it in `docker`. | ||
|
|
||
| ## Example | ||
| This example uses 2 nodes for remote deployment. One node (remote) is used to run all Edgex core services in docker and the other node (host) |
There was a problem hiding this comment.
Suggested change
| This example uses 2 nodes for remote deployment. One node (remote) is used to run all Edgex core services in docker and the other node (host) | |
| This example uses 2 nodes for remote deployment. One node (remote) is used to run all EdgeX core services in Docker and the other node (host) |
|
|
||
| ## Example | ||
| This example uses 2 nodes for remote deployment. One node (remote) is used to run all Edgex core services in docker and the other node (host) | ||
| for running the device-usb-camera service natively or in docker. Both the nodes are on the same network. |
There was a problem hiding this comment.
Suggested change
| for running the device-usb-camera service natively or in docker. Both the nodes are on the same network. | |
| for running the device-usb-camera service natively or in Docker. Both of the nodes are on the same network. |
|
|
||
| ## Running of the example | ||
|
|
||
| 1. Set up the two nodes to be ready for remote deployment. Refer [USB Service Setup](../supported/device-usb-camera/walkthrough/setup.md) |
There was a problem hiding this comment.
Suggested change
| 1. Set up the two nodes to be ready for remote deployment. Refer [USB Service Setup](../supported/device-usb-camera/walkthrough/setup.md) | |
| 1. Set up the two nodes to be ready for remote deployment. Refer to [USB Service Setup](../supported/device-usb-camera/walkthrough/setup.md) |
| ## Running of the example | ||
|
|
||
| 1. Set up the two nodes to be ready for remote deployment. Refer [USB Service Setup](../supported/device-usb-camera/walkthrough/setup.md) | ||
| for system requirements and dependencies such as Git, Docker, Docker compose, etc. Additional to this Golang needs to be installed |
There was a problem hiding this comment.
Suggested change
| for system requirements and dependencies such as Git, Docker, Docker compose, etc. Additional to this Golang needs to be installed | |
| for system requirements and dependencies such as Git, Docker, Docker Compose, etc. Additionally, Golang needs to be installed |
| for system requirements and dependencies such as Git, Docker, Docker compose, etc. Additional to this Golang needs to be installed | ||
| in the host node where the device-usb-camera service will be built and run natively. | ||
|
|
||
| 1. Next step is to install Edgex compose in the remote node which will be used to run all Edgex core services. So clone the `edgex-compose` |
There was a problem hiding this comment.
Suggested change
| 1. Next step is to install Edgex compose in the remote node which will be used to run all Edgex core services. So clone the `edgex-compose` | |
| 1. Next step is to install EdgeX Compose in the remote node which will be used to run all EdgeX core services. So clone the `edgex-compose` |
| git checkout {{version}} | ||
| ``` | ||
|
|
||
| 1. Update the `docker-compose-no-secty.yml` file by changing the `host_ip` address of all the Edgex core services to the remote node ip address. |
There was a problem hiding this comment.
Suggested change
| 1. Update the `docker-compose-no-secty.yml` file by changing the `host_ip` address of all the Edgex core services to the remote node ip address. | |
| 1. Update the `docker-compose-no-secty.yml` file by changing the `host_ip` address of all the EdgeX core services to the remote node ip address. |
| ``` | ||
|
|
||
| 1. Modify the `configuration.yml` file in the repo to run natively. Uncomment out the required parts as directed in the file. | ||
| Update the yml file with the `Host` and `Remote` node ip addresses.All the |
There was a problem hiding this comment.
Suggested change
| Update the yml file with the `Host` and `Remote` node ip addresses.All the | |
| Update the yml file with the `Host` and `Remote` node ip addresses. All the |
| The deployment can be done by running the service `natively` or by running it in `docker`. | ||
|
|
||
| ## Example | ||
| This example uses 2 nodes for remote deployment. One node (remote) is used to run all Edgex core services in docker and the other node (host) |
There was a problem hiding this comment.
this looks confusing to me. which node is host? the one running edgex or device usb?
can we say some thing like this? This example uses 2 nodes for remote deployment. One node (gateway) is used to run all EdgeX core services in Docker and the other node (remote) is used to run USB device service.
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
…ew comments Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
lenny-goodell
requested changes
Sep 20, 2023
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
seanohair22
reviewed
Sep 21, 2023
| git checkout {{edgexversion}} | ||
| ``` | ||
|
|
||
| 1. Update the [docker-compose-no-secty.yml](https://github.com/edgexfoundry/edgex-compose/blob/main/docker-compose-no-secty.yml) file by removing the `host_ip` section of all the Edgex core services. E.g. |
There was a problem hiding this comment.
Suggested change
| 1. Update the [docker-compose-no-secty.yml](https://github.com/edgexfoundry/edgex-compose/blob/main/docker-compose-no-secty.yml) file by removing the `host_ip` section of all the Edgex core services. E.g. | |
| 1. Update the [docker-compose-no-secty.yml](https://github.com/edgexfoundry/edgex-compose/blob/main/docker-compose-no-secty.yml) file by removing the `host_ip` section of all the EdgeX core services. E.g. |
| host_ip: 127.0.0.1 | ||
| ``` | ||
| The example line provided above should be removed from the services, the host_ip will be provided while running the usb service. | ||
| Non-Edgex core services such as device-rest, device-virtual, app-rules-engine, etc. can be removed or commented out if needed. |
There was a problem hiding this comment.
Suggested change
| Non-Edgex core services such as device-rest, device-virtual, app-rules-engine, etc. can be removed or commented out if needed. | |
| Non-EdgeX core services such as device-rest, device-virtual, app-rules-engine, etc. can be removed or commented out if needed. |
| The example line provided above should be removed from the services, the host_ip will be provided while running the usb service. | ||
| Non-Edgex core services such as device-rest, device-virtual, app-rules-engine, etc. can be removed or commented out if needed. | ||
|
|
||
| 1. Run Edgex core services: |
There was a problem hiding this comment.
Suggested change
| 1. Run Edgex core services: | |
| 1. Run EdgeX core services: |
| ``` | ||
|
|
||
| !!! note | ||
| If multiple instances of the service has to be run then add `EDGEX_INSTANCE_NAME` enviroment variable above with a value of number of instances desired. |
There was a problem hiding this comment.
Suggested change
| If multiple instances of the service has to be run then add `EDGEX_INSTANCE_NAME` enviroment variable above with a value of number of instances desired. | |
| If multiple instances of the service have to be run, then add `EDGEX_INSTANCE_NAME` environment variable above with a number to instantiate the current instance of the device-usb-camera service. |
|
|
||
| ## Verify Service, Device(s) and next steps | ||
|
|
||
| 1. Make sure the service has no errors and check whether the service is added to Edgex i.e. to core-metadata (running in host node): |
There was a problem hiding this comment.
Suggested change
| 1. Make sure the service has no errors and check whether the service is added to Edgex i.e. to core-metadata (running in host node): | |
| 1. Make sure the service has no errors and check whether the service is added to EdgeX i.e. to core-metadata (running in host node): |
presatish
changed the title
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
lenny-goodell
requested changes
Sep 25, 2023
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
lenny-goodell
requested changes
Sep 25, 2023
Signed-off-by: preethi-satishcandra <preethi.satishchandra@intel.com>
edgex-jenkins
added a commit
that referenced
this pull request
Sep 25, 2023
…e mode added (#1211) Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: