Skip to content

Commit

Permalink
docs: update terminology and urls for troubleshooting
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Gregory <[email protected]>
  • Loading branch information
ericgregory committed Oct 18, 2024
1 parent 799c904 commit d170ad8
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/deployment/security/policy-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 'Extending security and preventing untrusted workloads'
sidebar_position: 3
---

wasmCloud hosts will always enforce a certain level of security by default that _cannot be loosened_. For example, hosts will always validate [runtime links](/docs/developer/debugging/components#missing-runtime-links). Additionally, the wasmCloud **policy service API** can be used to extend and customize policy evaluation, such as by restricting untrusted application components and providers on particular hosts.
wasmCloud hosts will always enforce a certain level of security by default that _cannot be loosened_. For example, hosts will always validate [runtime links](/docs/developer/troubleshooting/components#missing-runtime-links). Additionally, the wasmCloud **policy service API** can be used to extend and customize policy evaluation, such as by restricting untrusted application components and providers on particular hosts.

### Policy evaluation flow

Expand Down
8 changes: 0 additions & 8 deletions docs/developer/debugging/_category_.json

This file was deleted.

8 changes: 8 additions & 0 deletions docs/developer/troubleshooting/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Troubleshooting",
"position": 5,
"link": {
"type": "doc",
"id": "developer/troubleshooting/index"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ draft: false

:::info

Before you follow this section, consider [configuring the log level](/docs/developer/debugging/host#changing-the-log-level) to `debug` for more information when debugging.
Before you follow this section, consider [configuring the log level](/docs/developer/troubleshooting/host#changing-the-log-level) to `debug` for more information when troubleshooting.

:::

Expand Down Expand Up @@ -55,7 +55,7 @@ The command line wasmCloud shell (aka [wash](https://github.com/wasmCloud/wasmCl

If any of the component ID, provider ID, link name, or contract ID are misspelled or omitted, then the host will deny the invocation.

## Debugging invocations
## Troubleshooting invocations

:::info

Expand All @@ -65,7 +65,7 @@ Note that the following commands are experimental and may change in the future.

### `wash spy`

`wash spy` monitors all invocations to/from a given component. This can be useful for debugging communication issues and identifying logic bugs. To use it, run:
`wash spy` monitors all invocations to/from a given component. This can be useful for troubleshooting communication issues and identifying logic bugs. To use it, run:

```bash
wash spy <component name or ID>
Expand Down Expand Up @@ -127,7 +127,7 @@ This output has the timestamp the invocation was observed at, the source and tar

### `wash capture`

This command enables you to debug an issue _after it occurs_ by capturing a window of all invocations in the lattice (1 hour by default). This is similar to many gaming tools that constantly capture your video while you game, and then with a press of a button you can save the last 60s for later use. `wash capture` can be useful for debugging issues that are difficult to reproduce only occur in specific environments.
This command enables you to debug an issue _after it occurs_ by capturing a window of all invocations in the lattice (1 hour by default). This is similar to many gaming tools that constantly capture your video while you game, and then with a press of a button you can save the last 60s for later use. `wash capture` can be useful for troubleshooting issues that are difficult to reproduce only occur in specific environments.

To use it, run:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/ecosystem/nats/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ With this basic model, queue groups and queue subscription facilitate horizontal

## Using the NATS CLI

You can interact directly with NATS using the NATS CLI. While it is not necessary to install the NATS CLI to use wasmCloud, it can be useful for debugging. Installation instructions for the CLI are available on the [NATS CLI GitHub repo](https://github.com/nats-io/natscli).
You can interact directly with NATS using the NATS CLI. While it is not necessary to install the NATS CLI to use wasmCloud, it can be useful for troubleshooting. Installation instructions for the CLI are available on the [NATS CLI GitHub repo](https://github.com/nats-io/natscli).

To list all streams on your NATS network:

Expand Down Expand Up @@ -99,7 +99,7 @@ The listed key-value buckets will include:
* `wadm_state`
* `LATTICEDATA_default`

For more information on debugging and NATS, see the [troubleshooting](/docs/developer/debugging/host#clear-nats-streams-and-buckets) section.
For more information on troubleshooting and NATS, see the [troubleshooting](/docs/developer/troubleshooting/host#clear-nats-streams-and-buckets) section.

## Keep reading

Expand Down
5 changes: 5 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,11 @@ redirects = [
{ from = "/docs/cli/update", to = "docs/cli/#wash-update", status = 301 },
{ from = "/docs/cli/plugin", to = "docs/cli/#wash-plugin", status = 301 },

{ from = "/docs/developer/debugging", to = "/docs/developer/troubleshooting/", status = 301 },
{ from = "/docs/developer/debugging/components", to = "/docs/developer/troubleshooting/components", status = 301 },
{ from = "/docs/developer/debugging/host", to = "/docs/developer/troubleshooting/host", status = 301 },
{ from = "/docs/developer/debugging/providers", to = "/docs/developer/troubleshooting/providers", status = 301 },

{ from = "/youtube", to = "https://www.youtube.com/@wasmCloud", status = 301 },
{ from = "/yt", to = "https://www.youtube.com/@wasmCloud", status = 301 },
{ from = "/innovation-day-2024", to = "https://www.youtube.com/watch?v=vEHbZCBmPok", status = 301 },
Expand Down

0 comments on commit d170ad8

Please sign in to comment.