Skip to content

Commit

Permalink
Update docs links to reflect restructured repo (#214)
Browse files Browse the repository at this point in the history
* Update docs links to reflect restructured repo
  • Loading branch information
ryysud authored Oct 29, 2020
1 parent 8637c40 commit 5aeb9fb
Show file tree
Hide file tree
Showing 21 changed files with 66 additions and 67 deletions.
4 changes: 2 additions & 2 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The WebAssembly Hub acts as an image registry for WebAssembly Filters hosted at
- compile [Envoy WebAssembly](https://github.com/envoyproxy/envoy-wasm) filters on a local machine (the only dependency is `docker`)
- push filters to https://webassemblyhub.io
- pull filters from https://webassemblyhub.io
- publish filters to the catalog at https://webassemblyhub.io/extensions/
- publish filters to the catalog at https://webassemblyhub.io/extensions/

### Getting Started

Expand All @@ -34,4 +34,4 @@ See the [Getting Started tutorial](https://docs.solo.io/web-assembly-hub/latest/
- Join us on our Slack channel: [https://slack.solo.io/](https://slack.solo.io/)
- Follow us on Twitter: [https://twitter.com/soloio_inc](https://twitter.com/soloio_inc)
- Check out the docs: [https://docs.solo.io/web-assembly-hub/latest](https://docs.solo.io/web-assembly-hub/latest)
- Contribute to the [Docs](https://github.com/solo-io/wasme)
- Contribute to the [Docs](https://github.com/solo-io/wasm)
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.12/operator-implementation.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: NEW_FEATURE
description: Adds the new Wasme Operator for deploying filters to production.
issueLink: https://github.com/solo-io/wasme/issues/42
issueLink: https://github.com/solo-io/wasm/issues/42
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.13/fix-deploy-local.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: 'Fix `wasme deploy envoy` command and update it with a cleaner experience using the local cache.'
issueLink: https://github.com/solo-io/wasme/issues/72
issueLink: https://github.com/solo-io/wasm/issues/72
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.13/gloo-e2e.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ changelog:
description: 'Update & improve documentation'
- type: NEW_FEATURE
description: 'Support use of labelSelector to deploy filters to Istio'
issueLink: https://github.com/solo-io/wasme/issues/43
issueLink: https://github.com/solo-io/wasm/issues/43
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.13/operator-implementation.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: NEW_FEATURE
description: 'Adds support for `init` and `build` for the AssemblyScript language: https://github.com/AssemblyScript/assemblyscript'
issueLink: https://github.com/solo-io/wasme/issues/71
issueLink: https://github.com/solo-io/wasm/issues/71
3 changes: 1 addition & 2 deletions tools/wasme/changelog/v0.0.14/operator-implementation.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
changelog:
- type: NEW_FEATURE
description: 'List all repos with `wasme list`'
issueLink: https://github.com/solo-io/wasme/issues/80

issueLink: https://github.com/solo-io/wasm/issues/80
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.16/cache-race.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix cache race by firing events
issueLink: https://github.com/solo-io/wasme/issues/64
issueLink: https://github.com/solo-io/wasm/issues/64
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.17/cache-race.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix issue where `wasme list` would return an error if the cache had not been initialized with `wasme build` or `wasme pull`.
issueLink: https://github.com/solo-io/wasme/issues/87
issueLink: https://github.com/solo-io/wasm/issues/87
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix incorrect base selection on wasme init command.
issueLink: https://github.com/solo-io/wasme/issues/90
issueLink: https://github.com/solo-io/wasm/issues/90
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.19/cache-race.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix issue where `wasme list` returns an empty list if --store is not set
issueLink: https://github.com/solo-io/wasme/issues/87
issueLink: https://github.com/solo-io/wasm/issues/87
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Allow wasme cache to use credentials given to its command line.
issueLink: https://github.com/solo-io/wasme/pull/102
issueLink: https://github.com/solo-io/wasm/pull/102
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.21/add-istio-1.6-support.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: NEW_FEATURE
description: 'Add support for Istio v1.6.x'
issueLink: https://github.com/solo-io/wasme/issues/126
issueLink: https://github.com/solo-io/wasm/issues/126
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.21/fix-bookinfo-url
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix Bookinfo URL.
issueLink: https://github.com/solo-io/wasme/issues/122
issueLink: https://github.com/solo-io/wasm/issues/122
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.21/fix-typo-cahced.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix user-facing typo - cahced.
issueLink: https://github.com/solo-io/wasme/issues/77
issueLink: https://github.com/solo-io/wasm/issues/77
4 changes: 2 additions & 2 deletions tools/wasme/changelog/v0.0.21/gloo-1.5.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
changelog:
- type: NEW_FEATURE
description: 'Add support for gloo v1.5.x'
issueLink: https://github.com/solo-io/wasme/issues/130
issueLink: https://github.com/solo-io/wasm/issues/130
- type: NON_USER_FACING
description: Fix broken build by pinning skv2 version and formatting imports
issueLink: https://github.com/solo-io/wasme/issues/124
issueLink: https://github.com/solo-io/wasm/issues/124
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.21/gloo-and-istio-support.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Allows using --config param in CLI deploy command for both Istio and Gloo again
issueLink: https://github.com/solo-io/wasme/issues/130
issueLink: https://github.com/solo-io/wasm/issues/130
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.21/use-recent-envoy.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Use a more recent envoy for local deploy.
issueLink: https://github.com/solo-io/wasme/issues/107
issueLink: https://github.com/solo-io/wasm/issues/107
2 changes: 1 addition & 1 deletion tools/wasme/changelog/v0.0.26/version-fix.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: FIX
description: Fix a bug in version linking which caused the version to be 'dev' on release.
issueLink: https://github.com/solo-io/wasme/issues/158
issueLink: https://github.com/solo-io/wasm/issues/158
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You'll be asked with an interactive prompt which language platform you are build
```

```
INFO[0014] extracting 1973 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasme/assemblyscript-filter
INFO[0014] extracting 1973 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasm/assemblyscript-filter
```

The `init` command will place our *base* filter into the `assemblyscript-filter` directory:
Expand Down Expand Up @@ -63,10 +63,10 @@ The new directory contains all files necessary to build and deploy a WASM filter

| File | Description |
| ----- | ---- |
| `assembly/index.ts` | The source code for the filter, written in AssemblyScript. |
| `assembly/tsconfig.json` | Typescript config file (AssemblyScript is a subset of Typescript). |
| `package.json` | Used by to import npm modules during build time. |
| `package-lock.json` | Locked npm modules. |
| `assembly/index.ts` | The source code for the filter, written in AssemblyScript. |
| `assembly/tsconfig.json` | Typescript config file (AssemblyScript is a subset of Typescript). |
| `package.json` | Used by to import npm modules during build time. |
| `package-lock.json` | Locked npm modules. |
| `runtime-config.json` | Config stored with the filter image used to load the filter at runtime. |

Open `assembly/index.ts` in your favorite text editor. The source code is AssemblyScript and we'll make some changes to customize our new filter.
Expand All @@ -90,7 +90,7 @@ Your method should look like this:

## Building the filter

Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.

Images tagged with `wasme` have the following format:

Expand All @@ -99,7 +99,7 @@ Images tagged with `wasme` have the following format:
```

* `<registry address>` specifies the address of the remote OCI registry where the image will be pushed by the `wasme push` command. The project authors maintain a free public registry at `webassemblyhub.io`.

* `<registry username|org>` either your username for the remote OCI registry, or a valid org name with which you are registered.


Expand All @@ -115,11 +115,11 @@ wasme build assemblyscript -t webassemblyhub.io/$YOUR_USERNAME/add-header:v0.1 .
```

{{% notice note %}}
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
{{% /notice %}}

The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
build steps.
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
build steps.

When the build has finished, you'll be able to see the image with `wasme list`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Let's create a new filter called `cpp-filter`:
wasme init cpp-filter
```

You'll be asked with an interactive prompt which language platform you are building for. At time of writing, `wasme` includes separate bases
You'll be asked with an interactive prompt which language platform you are building for. At time of writing, `wasme` includes separate bases
for Istio 1.5.x and Gloo 1.3.x:

{{< tabs >}}
Expand All @@ -39,7 +39,7 @@ You'll be asked with an interactive prompt which language platform you are build
{{< /tabs >}}

```
INFO[0014] extracting 5072 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasme/cpp-filter
INFO[0014] extracting 5072 bytes to /Users/ilackarms/go/src/github.com/solo-io/wasm/cpp-filter
```

The `init` command will place our *base* filter into the `cpp-filter` directory:
Expand Down Expand Up @@ -85,12 +85,12 @@ The new directory contains all files necessary to build and deploy a WASM filter

| File | Description |
| ----- | ---- |
| `BUILD` | The Bazel BUILD file used to build the filter. |
| `WORKSPACE` | The Bazel WORKSPACE file used to build the filter. |
| `bazel/` | Bazel external dependencies. |
| `toolchain/` | Bazel tooling for building wasm modules. |
| `filter.cc` | The source code for the filter, written in C++. |
| `filter.proto` | The protobuf schema of the filter configuration. |
| `BUILD` | The Bazel BUILD file used to build the filter. |
| `WORKSPACE` | The Bazel WORKSPACE file used to build the filter. |
| `bazel/` | Bazel external dependencies. |
| `toolchain/` | Bazel tooling for building wasm modules. |
| `filter.cc` | The source code for the filter, written in C++. |
| `filter.proto` | The protobuf schema of the filter configuration. |
| `runtime-config.json` | Config stored with the filter image used to load the filter at runtime. |

Open `filter.cc` in your favorite text editor. We'll make some changes to customize our new filter.
Expand All @@ -116,7 +116,7 @@ The code above will add the `hello: world!` header to HTTP responses processed b
## Building the filter
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
Now, let's build a WASM image from our filter with `wasme`. The filter will be tagged and stored in a local registry, similar to how [Docker](https://www.docker.com/) stores images.
Images tagged with `wasme` have the following format:
Expand All @@ -125,7 +125,7 @@ Images tagged with `wasme` have the following format:
```
* `<registry address>` specifies the address of the remote OCI registry where the image will be pushed by the `wasme push` command. The project authors maintain a free public registry at `webassemblyhub.io`.
* `<registry username|org>` either your username for the remote OCI registry, or a valid org name with which you are registered.
Expand All @@ -141,11 +141,11 @@ wasme build cpp -t webassemblyhub.io/$YOUR_USERNAME/add-header:v0.1 .
```

{{% notice note %}}
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
`wasme build` runs a build container inside of Docker which may run into issues due to SELinux (on Linux environments). To disable, run `sudo setenforce 0`
{{% /notice %}}

The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
build steps.
The module will take up to a few minutes to build. In the background, `wasme` has launched a Docker container to run the necessary
build steps.

When the build has finished, you'll be able to see the image with `wasme list`:

Expand Down
Loading

0 comments on commit 5aeb9fb

Please sign in to comment.