#wasmcloud

wadm

wasmCloud Application Deployment Manager: A tool for running Wasm applications in wasmCloud

30 releases (8 breaking)

new 0.12.0 May 24, 2024
0.11.1 Apr 30, 2024
0.10.0 Jan 18, 2024
0.9.1 Dec 19, 2023
0.5.0-alpha.1 Jul 25, 2023

#41 in WebAssembly

Download history 206/week @ 2024-02-02 405/week @ 2024-02-09 243/week @ 2024-02-16 270/week @ 2024-02-23 223/week @ 2024-03-01 493/week @ 2024-03-08 855/week @ 2024-03-15 491/week @ 2024-03-22 410/week @ 2024-03-29 767/week @ 2024-04-05 1006/week @ 2024-04-12 545/week @ 2024-04-19 676/week @ 2024-04-26 457/week @ 2024-05-03 459/week @ 2024-05-10 470/week @ 2024-05-17

2,371 downloads per month
Used in 2 crates

Apache-2.0

670KB
14K SLoC

wadm logo

wasmCloud Application Deployment Manager (wadm)

The wasmCloud Application Deployment Manager (wadm) enables declarative wasmCloud applications. It's responsible for managing a set of application deployment specifications, monitoring the current state of an entire lattice, and issuing the appropriate lattice control commands required to close the gap between observed and desired state.

Using wadm

Open in GitHub Codespaces

Install & Run

You can easily run wadm by downloading the wash CLI, which automatically launches wadm alongside NATS and a wasmCloud host when you run wash up. You can use wash to query, create, and deploy applications.

wash up -d    # Start NATS, wasmCloud, and wadm in the background

Follow the wasmCloud quickstart to get started building and deploying an application, or follow the Deploying an application example below to simply try a deploy.

If you prefer to run wadm separately and/or connect to running wasmCloud hosts, you can instead opt for using the latest GitHub release artifact and executing the binary. Simply replace the latest version, your operating system, and architecture below. Please note that wadm requires a wasmCloud host version >=0.63.0

# Install wadm
curl -fLO https://github.com/wasmCloud/wadm/releases/download/<version>/wadm-<version>-<os>-<arch>.tar.gz
tar -xvf wadm-<version>-<os>-<arch>.tar.gz
cd wadm-<version>-<os>-<arch>
./wadm

Deploying an application

Copy the following manifest and save it locally as hello.yaml (you can also find it in the oam directory):

# Metadata
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: hello-world
  annotations:
    description: 'HTTP hello world demo'
spec:
  components:
    - name: http-component
      type: component
      properties:
        # Run components from OCI registries as below or from a local .wasm component binary.
        image: wasmcloud.azurecr.io/http-hello-world:0.1.0
      traits:
        # One replica of this component will run
        - type: spreadscaler
          properties:
            replicas: 1
    # The httpserver capability provider, started from the official wasmCloud OCI artifact
    - name: httpserver
      type: capability
      properties:
        image: ghcr.io/wasmcloud/http-server:0.20.0
      traits:
        # Link the HTTP server and set it to listen on the local machine's port 8080
        - type: link
          properties:
            target: http-component
            namespace: wasi
            package: http
            interfaces: [incoming-handler]
            source_config:
              - name: default-http
                properties:
                  ADDRESS: 127.0.0.1:8080

Then use wash to deploy the manifest:

wash app deploy hello.yaml

🎉 You've just launched your first application with wadm! Try curl localhost:8080.

When you're done, you can use wash to undeploy the application:

wash app undeploy hello-world

Modifying applications

wadm supports upgrading applications by deploying new versions of manifests. Try changing the manifest you created above by updating the number of replicas.

<<ELIDED>>
metadata:
  name: hello-world
  annotations:
    description: 'HTTP hello world demo'
spec:
  components:
    - name: http-component
      type: component
      properties:
        image: wasmcloud.azurecr.io/http-hello-world:0.1.0
      traits:
        - type: spreadscaler
          properties:
            replicas: 10 # Let's have 10!
<<ELIDED>>

Then simply deploy the new manifest:

wash app deploy hello.yaml

Now wasmCloud is configured to automatically scale your component to 10 replicas based on incoming load.

Responsibilities

wadm has a very small set of responsibilities, which actually contributes to its power.

  • Manage Application Specifications - Manage models consisting of desired state. This includes the creation and deletion and rollback of models to previous versions. Application specifications are defined using the Open Application Model. For more information on wadm's specific OAM features, see our OAM README.
  • Observe State - Monitor wasmCloud CloudEvents from all hosts in a lattice to build the current state.
  • Take Compensating Actions - When indicated, issue commands to the lattice control interface to bring about the changes necessary to make the desired and observed state match.

🚧 Advanced

You can find a Docker Compose file for deploying an end-to-end multi-tenant example in the test directory.

In advanced use cases, wadm is also capable of:

  • Monitoring multiple lattices.
  • Running multiple instances to distribute load among multiple processes, or for a high-availability architecture.

🚧 Multi-lattice and multi-process functionality is somewhat tested, but not as rigorously as a single instance monitoring a single lattice. Proceed with caution while we do further testing.

API

Interacting with wadm is done over NATS on the root topic wadm.api.{prefix} where prefix is the lattice namespace prefix. For more information on this API, please consult the wadm Reference.

Known Issues/Missing functionality

As this is a new project there are some things we know are missing or buggy. A non-exhaustive list of these can be found below:

  • It is technically possible as things stand right now for a race condition with manifests when a manifest is updated/created and deleted simultaneously. In this case, one of the operations will win and you will end up with a manifest that still exists after you delete it or a manifest that does not exist after you create it. This is a very unlikely scenario as only one person or process is interacting with a specific, but it is possible. If this becomes a problem for you, please let us know and we will consider additional ways of how we can address it.
  • Manifest validation is implemented, but slightly clunky. Any PRs that make this better would be more than welcome!

References

The wasmCloud Application Deployment Manager (wadm) originally came from the autonomous lattice controller RFC and then was reworked in version 0.4 in response to the tidying and productioning RFC.

Dependencies

~36–52MB
~1M SLoC