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.

Sign up for GitHub

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

fix link to target provider docs throughout the book #411

Merged
merged 1 commit into from
Aug 21, 2024
Merged

fix link to target provider docs throughout the book #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/symphony-book/agent/target-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -97,4 +97,4 @@ spec:
requestTopic: "coa-request"
responseTopic: "coa-response"
timeoutSeconds: "30"
```
```
4 changes: 2 additions & 2 deletions docs/symphony-book/concepts/unified-object-model/target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -49,4 +49,4 @@ topologies:

## Related topics

* [Providers](../../providers/_overview.md)
* [Providers](../../providers/_overview.md)
2 changes: 1 addition & 1 deletion docs/symphony-book/dev-guide/_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/symphony-book/get-started/deploy_redis_no_k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/symphony-book/managers/solution-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/symphony-book/providers/_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
* [Write a Python-based provider](./python_provider.md)
Loading