From ccbcbbd5737a8c1dd0bdc66cad6e0f79b0403fa8 Mon Sep 17 00:00:00 2001 From: Shubham Patil Date: Sat, 17 Aug 2024 22:28:02 +0530 Subject: [PATCH] fix link to target provider docs throughout the book --- docs/symphony-book/agent/target-agent.md | 4 ++-- docs/symphony-book/concepts/unified-object-model/target.md | 4 ++-- docs/symphony-book/dev-guide/_overview.md | 2 +- docs/symphony-book/get-started/deploy_redis_no_k8s.md | 2 +- docs/symphony-book/managers/solution-manager.md | 2 +- docs/symphony-book/providers/_overview.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/symphony-book/agent/target-agent.md b/docs/symphony-book/agent/target-agent.md index 8adc2a05a..828fce603 100644 --- a/docs/symphony-book/agent/target-agent.md +++ b/docs/symphony-book/agent/target-agent.md @@ -2,7 +2,7 @@ _(last edit: 6/4/2024)_ -A Symphony target agent hosts [target providers](../providers/target_provider.md) outside of the Symphony API process. The Symphony API process communicates with target agents through either HTTP or MQTT. You can configure a target agent to represent one or multiple [targets](../concepts/unified-object-model/target.md). +A Symphony target agent hosts [target providers](../providers/target-providers/target_provider.md) outside of the Symphony API process. The Symphony API process communicates with target agents through either HTTP or MQTT. You can configure a target agent to represent one or multiple [targets](../concepts/unified-object-model/target.md). ![Target Agent](../images/target-agent.png) @@ -97,4 +97,4 @@ spec: requestTopic: "coa-request" responseTopic: "coa-response" timeoutSeconds: "30" -``` \ No newline at end of file +``` diff --git a/docs/symphony-book/concepts/unified-object-model/target.md b/docs/symphony-book/concepts/unified-object-model/target.md index 15ae77121..7dc74568a 100644 --- a/docs/symphony-book/concepts/unified-object-model/target.md +++ b/docs/symphony-book/concepts/unified-object-model/target.md @@ -36,7 +36,7 @@ components: ## Role bindings -A component is bound to a [provider](../../providers/target_provider.md) through a role binding by component type. For example, the following binding binds a `yaml.k8s` component type to a `providers.target.kubectl` provider. +A component is bound to a [provider](../../providers/target-providers/target_provider.md) through a role binding by component type. For example, the following binding binds a `yaml.k8s` component type to a `providers.target.kubectl` provider. ```yaml topologies: @@ -49,4 +49,4 @@ topologies: ## Related topics -* [Providers](../../providers/_overview.md) \ No newline at end of file +* [Providers](../../providers/_overview.md) diff --git a/docs/symphony-book/dev-guide/_overview.md b/docs/symphony-book/dev-guide/_overview.md index 961c36f03..671acb8ca 100644 --- a/docs/symphony-book/dev-guide/_overview.md +++ b/docs/symphony-book/dev-guide/_overview.md @@ -29,7 +29,7 @@ The Symphony repo lacks automatic CI/CD pipelines, gated check-ins, and automate ## Write a provider -A common task of extending Symphony is to write or modify a [provider](../providers/_overview.md), especially a [target provider](../providers/target_provider.md). +A common task of extending Symphony is to write or modify a [provider](../providers/_overview.md), especially a [target provider](../providers/target-providers/target_provider.md). A target provider implements the [target provider interface](../providers/provider_interface.md). diff --git a/docs/symphony-book/get-started/deploy_redis_no_k8s.md b/docs/symphony-book/get-started/deploy_redis_no_k8s.md index 78d21c51a..9601c9a41 100644 --- a/docs/symphony-book/get-started/deploy_redis_no_k8s.md +++ b/docs/symphony-book/get-started/deploy_redis_no_k8s.md @@ -37,7 +37,7 @@ The response body contains an access token, which you need to attach to the subs ## Define a target -Define your current machine as a [target](../concepts/unified-object-model/target.md) with a Docker [target provider](../providers/target_provider.md): +Define your current machine as a [target](../concepts/unified-object-model/target.md) with a Docker [target provider](../providers/target-providers/target_provider.md): * **ADDRESS**: http://localhost:8082/v1alpha2/targets/registry/sample-docker-target * **METHOD**: POST diff --git a/docs/symphony-book/managers/solution-manager.md b/docs/symphony-book/managers/solution-manager.md index 71ed813be..c365892df 100644 --- a/docs/symphony-book/managers/solution-manager.md +++ b/docs/symphony-book/managers/solution-manager.md @@ -2,7 +2,7 @@ _(last edit: 6/28/2023)_ -Solution manager implements core Symphony state-seeking logic. It takes a [deployment](../concepts/unified-object-model/deployment.md) spec, plans deployment steps, and invokes corresponding [target providers](../providers/target_provider.md) to drive system states towards the desired state. +Solution manager implements core Symphony state-seeking logic. It takes a [deployment](../concepts/unified-object-model/deployment.md) spec, plans deployment steps, and invokes corresponding [target providers](../providers/target-providers/target_provider.md) to drive system states towards the desired state. Solution manager is the only stateful component in the Symphony system. When you scale out solution manager, you need to configure your solution manager instances to use a shared state store. diff --git a/docs/symphony-book/providers/_overview.md b/docs/symphony-book/providers/_overview.md index 8b91840d1..2d612d4f0 100644 --- a/docs/symphony-book/providers/_overview.md +++ b/docs/symphony-book/providers/_overview.md @@ -8,7 +8,7 @@ Common provider types include: * Proxy, like [HTTP proxy](./http_proxy_provider.md) and [MQTT proxy](./mqtt_proxy_provider.md) * [Reference](./reference_provider.md) -* [Target](./target_provider.md) +* [Target](./target-providers/target_provider.md) * [Staging](./staging_provider.md) * Certificate * Probe @@ -21,4 +21,4 @@ Common provider types include: * [Target Provider interface](./target-providers/provider_interface.md) * [State Provider interface](./state-providers/_overview.md) -* [Write a Python-based provider](./python_provider.md) \ No newline at end of file +* [Write a Python-based provider](./python_provider.md)