diff --git a/docs_src/general/ServiceConfiguration.md b/docs_src/general/ServiceConfiguration.md index b4f65f894..3c6e77e7a 100644 --- a/docs_src/general/ServiceConfiguration.md +++ b/docs_src/general/ServiceConfiguration.md @@ -4,7 +4,7 @@ Each EdgeX micro service requires configuration (i.e. - a repository of initiali See the [Configuration and Registry documentation](../microservices/configuration/ConfigurationAndRegistry.md) for more details about initialization of services and the use of the configuration service. -Please refer to the EdgeX Foundry [architectural decision record](https://github.com/edgexfoundry/edgex-docs/blob/master/docs_src/design/adr/0005-Service-Self-Config.md) for details (and design decisions) behind the configuration in EdgeX. +Please refer to the EdgeX Foundry [architectural decision record](../design/adr/0005-Service-Self-Config.md) for details (and design decisions) behind the configuration in EdgeX. Please refer to the general [Common Configuration documentation](../microservices/configuration/CommonConfiguration.md) for configuration properties common to all services. Find service specific configuration references in the tabs below. diff --git a/docs_src/microservices/application/AdvancedTopics.md b/docs_src/microservices/application/AdvancedTopics.md index 2d646136f..04d583d58 100644 --- a/docs_src/microservices/application/AdvancedTopics.md +++ b/docs_src/microservices/application/AdvancedTopics.md @@ -183,7 +183,7 @@ Database configuration section describes which database type to use and the info When an export function encounters an error sending data it can call `SetRetryData(payload []byte)` on the `AppFunctionContext`. This will store the data for later retry. If the Application Service is stopped and then restarted while stored data hasn't been successfully exported, the export retry will resume once the service is up and running again. !!! note - It is important that export functions return an error and stop pipeline execution after the call to `SetRetryData`. See [HTTPPost](https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/pkg/transforms/http.go) function in SDK as an example + It is important that export functions return an error and stop pipeline execution after the call to `SetRetryData`. See [HTTPPost](https://github.com/edgexfoundry/app-functions-sdk-go/blob/{{version}}/pkg/transforms/http.go) function in SDK as an example When the `RetryInterval` expires, the function pipeline will be re-executed starting with the export function that saved the data. The saved data will be passed to the export function which can then attempt to resend the data. diff --git a/docs_src/microservices/application/AppFunctionContextAPI.md b/docs_src/microservices/application/AppFunctionContextAPI.md index 93b908e73..379b2c714 100644 --- a/docs_src/microservices/application/AppFunctionContextAPI.md +++ b/docs_src/microservices/application/AppFunctionContextAPI.md @@ -73,43 +73,43 @@ Returns a `LoggingClient` to leverage logging libraries/service utilized through `EventClient() interfaces.EventClient` -Returns an `EventClient` to leverage Core Data's `Event` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/event.go) for more details. This client is useful for querying events. Note if Core Data is not specified in the Clients configuration, this will return nil. +Returns an `EventClient` to leverage Core Data's `Event` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/event.go) for more details. This client is useful for querying events. Note if Core Data is not specified in the Clients configuration, this will return nil. ### CommandClient `CommandClient() interfaces.CommandClient` -Returns a `CommandClient` to leverage Core Command's `Command` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/command.go) for more details. Useful for sending commands to devices. Note if Core Command is not specified in the Clients configuration, this will return nil. +Returns a `CommandClient` to leverage Core Command's `Command` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/command.go) for more details. Useful for sending commands to devices. Note if Core Command is not specified in the Clients configuration, this will return nil. ### NotificationClient `NotificationClient() interfaces.NotificationClient` -Returns a `NotificationClient` to leverage Support Notifications' `Notifications` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/notification.go) for more details. Useful for sending notifications. Note if Support Notifications is not specified in the Clients configuration, this will return nil. +Returns a `NotificationClient` to leverage Support Notifications' `Notifications` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/notification.go) for more details. Useful for sending notifications. Note if Support Notifications is not specified in the Clients configuration, this will return nil. ### SubscriptionClient `SubscriptionClient() interfaces.SubscriptionClient` -Returns a `SubscriptionClient` to leverage Support Notifications' `Subscription` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/subscription.go) for more details. Useful for creating notification subscriptions. Note if Support Notifications is not specified in the Clients configuration, this will return nil. +Returns a `SubscriptionClient` to leverage Support Notifications' `Subscription` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/subscription.go) for more details. Useful for creating notification subscriptions. Note if Support Notifications is not specified in the Clients configuration, this will return nil. ### DeviceServiceClient `DeviceServiceClient() interfaces.DeviceServiceClient` -Returns a `DeviceServiceClient` to leverage Core Metadata's `DeviceService` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/deviceservice.go) for more details. Useful for querying information about Device Services. Note if Core Metadata is not specified in the Clients configuration, this will return nil. +Returns a `DeviceServiceClient` to leverage Core Metadata's `DeviceService` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/deviceservice.go) for more details. Useful for querying information about Device Services. Note if Core Metadata is not specified in the Clients configuration, this will return nil. ### DeviceProfileClient `DeviceProfileClient() interfaces.DeviceProfileClient` -Returns a `DeviceProfileClient` to leverage Core Metadata's `DeviceProfile` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/deviceprofile.go) for more details. Useful for querying information about Device Profiles and is used by the `GetDeviceResource` helper function below. Note if Core Metadata is not specified in the Clients configuration, this will return nil. +Returns a `DeviceProfileClient` to leverage Core Metadata's `DeviceProfile` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/deviceprofile.go) for more details. Useful for querying information about Device Profiles and is used by the `GetDeviceResource` helper function below. Note if Core Metadata is not specified in the Clients configuration, this will return nil. ### DeviceClient `DeviceClient() interfaces.DeviceClient` -Returns a `DeviceClient` to leverage Core Metadata's `Device` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/master/clients/interfaces/device.go) for more details. Useful for querying information about Devices. Note if Core Metadata is not specified in the Clients configuration, this will return nil. +Returns a `DeviceClient` to leverage Core Metadata's `Device` API. See [interface definition](https://github.com/edgexfoundry/go-mod-core-contracts/blob/{{version}}/clients/interfaces/device.go) for more details. Useful for querying information about Devices. Note if Core Metadata is not specified in the Clients configuration, this will return nil. ### Note about Clients diff --git a/docs_src/microservices/application/AppServiceConfigurable.md b/docs_src/microservices/application/AppServiceConfigurable.md index d3168e542..67ae1851e 100644 --- a/docs_src/microservices/application/AppServiceConfigurable.md +++ b/docs_src/microservices/application/AppServiceConfigurable.md @@ -161,7 +161,7 @@ One can optionally add Filter function via environment overrides - `WRITABLE_PIPELINE_EXECUTIONORDER: "FilterByDeviceName, HTTPExport"` - `WRITABLE_PIPELINE_FUNCTIONS_FILTERBYDEVICENAME_PARAMETERS_DEVICENAMES: "[comma separated list]"` -There are many optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/master/res/rules-engine/configuration.yaml) for more details +There are many optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/{{version}}/res/rules-engine/configuration.yaml) for more details ### http-export @@ -171,7 +171,7 @@ Required: - `WRITABLE_PIPELINE_FUNCTIONS_HTTPEXPORT_PARAMETERS_URL: [Your URL]` - There are many more optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/master/res/http-export/configuration.yaml) for more details. + There are many more optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/{{version}}/res/http-export/configuration.yaml) for more details. ### metrics-influxdb @@ -226,11 +226,11 @@ Required: - `WRITABLE_PIPELINE_FUNCTIONS_MQTTEXPORT_PARAMETERS_BROKERADDRESS: [Your Broker Address]` - There are many optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/master/res/mqtt-export/configuration.yaml) for more details + There are many optional functions and parameters provided in this profile. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/{{version}}/res/mqtt-export/configuration.yaml) for more details ### sample -Sample profile with all available functions declared and a sample pipeline. Provided as a sample that can be copied and modified to create new custom profiles. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/master/res/sample/configuration.yaml) for more details +Sample profile with all available functions declared and a sample pipeline. Provided as a sample that can be copied and modified to create new custom profiles. See the [complete profile](https://github.com/edgexfoundry/app-service-configurable/blob/{{version}}/res/sample/configuration.yaml) for more details ### functional-tests diff --git a/docs_src/microservices/application/GettingStarted.md b/docs_src/microservices/application/GettingStarted.md index 74ceecdb1..e97fe055c 100644 --- a/docs_src/microservices/application/GettingStarted.md +++ b/docs_src/microservices/application/GettingStarted.md @@ -14,7 +14,7 @@ Custom Application Services are needed when use case needs can not be meet with ### Template -To help accelerate the creation of your custom Application Service the `App Functions SDK` contains a template for new custom Application Services. This template has TODO's in the code and a README that walk you through the creation of your new custom Application Service. See the template [README](https://github.com/edgexfoundry/app-functions-sdk-go/tree/master/app-service-template#readme) for more details. +To help accelerate the creation of your custom Application Service the `App Functions SDK` contains a template for new custom Application Services. This template has TODO's in the code and a README that walk you through the creation of your new custom Application Service. See the template [README](https://github.com/edgexfoundry/app-functions-sdk-go/tree/{{version}}/app-service-template#readme) for more details. ## Triggers diff --git a/docs_src/microservices/application/Triggers.md b/docs_src/microservices/application/Triggers.md index fe4404117..5a091ebc7 100644 --- a/docs_src/microservices/application/Triggers.md +++ b/docs_src/microservices/application/Triggers.md @@ -66,7 +66,7 @@ edgex/events/device//// This with App Services capability to have multiple subscriptions allows for multiple filters by subscriptions. The `SubscribeTopics` setting takes a comma separated list of subscribe topics. - Here are a few examples of how to configure the `SubscribeTopics` setting under the `Trigger.EdgexMessageBus.SubscribeHost` section to filter by subscriptions using the `profile`, `device` and `source` names from the SNMP Device Service file [here](https://github.com/edgexfoundry/device-snmp-go/tree/master/cmd/res): + Here are a few examples of how to configure the `SubscribeTopics` setting under the `Trigger.EdgexMessageBus.SubscribeHost` section to filter by subscriptions using the `profile`, `device` and `source` names from the SNMP Device Service file [here](https://github.com/edgexfoundry/device-snmp-go/tree/{{version}}/cmd/res): - Filter for all Events (default in common Trigger configuration) diff --git a/docs_src/security/Ch-Configuring-Add-On-Services.md b/docs_src/security/Ch-Configuring-Add-On-Services.md index 36c38146e..e8999ce80 100644 --- a/docs_src/security/Ch-Configuring-Add-On-Services.md +++ b/docs_src/security/Ch-Configuring-Add-On-Services.md @@ -14,7 +14,7 @@ software stack running in secure mode. This can be done vai Docker-compose file environment variables and some modification of micro-service's Dockerfile. From `edgex-compose` repository, the `compose-builder` utility provides some ways to deal with those add-on services like through `add-security.yml` via `make` targets to generate `docker-compose` file for running them in secure mode. For more details, please refer to -[README documentation of compose-builder](https://github.com/edgexfoundry/edgex-compose/blob/master/compose-builder/README.md). +[README documentation of compose-builder](https://github.com/edgexfoundry/edgex-compose/blob/{{version}}/compose-builder/README.md). The above same guidelines can also be applied to custom device and application services, i.e. non-EdgeX built services. diff --git a/docs_src/security/Ch-SecretStore.md b/docs_src/security/Ch-SecretStore.md index e7695ef4e..1b2c37ead 100644 --- a/docs_src/security/Ch-SecretStore.md +++ b/docs_src/security/Ch-SecretStore.md @@ -52,7 +52,7 @@ with respect to all of the other EdgeX services is covered in the ### Preferred Approach The preferred approach for interacting with the EdgeX secret store is to use the -`SecretClient` interface in [go-mod-secrets](https://github.com/edgexfoundry/go-mod-secrets/blob/master/secrets/interfaces.go). +`SecretClient` interface in [go-mod-secrets](https://github.com/edgexfoundry/go-mod-secrets/blob/{{version}}/secrets/interfaces.go). Each EdgeX microservice has access to a `StoreSecrets()` method that allows setting of per-microservice secrets, and a `GetSecrets()` method to read them back.