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

feat(instance): add section to cover stream attach support #51

Merged
merged 2 commits into from
May 15, 2024
Merged

feat(instance): add section to cover stream attach support #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9e9fea
feat(instance): add section to cover stream attach support
morphis Mar 22, 2024
7297b84
Merge branch 'main' into add-stream-attach
keirthana May 15, 2024
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
16 changes: 16 additions & 0 deletions howto/instance/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,22 @@ Launch a raw instance by providing the image ID in the following command:

See [Provided images](https://discourse.ubuntu.com/t/provided-images/24185) for a list of images that are available in Anbox Cloud.

### Launch an instance with streaming enabled

*since 1.22.0*

If you want to stream the visual output from an instance, specify it at the time of instance creation. Otherwise, the instance cannot be streamed. In previous versions of Anbox Cloud, it was only possible to create an instance that has streaming enabled via the [Stream Gateway API](https://canonical.github.io/anbox-cloud.github.com/latest/anbox-stream-gateway/). The same can now be achieved through the [AMS API](https://canonical.github.io/anbox-cloud.github.com/latest/ams/) or the `amc` CLI.

morphis marked this conversation as resolved.
Show resolved Hide resolved
To enable streaming for a new instance, simply run:

amc launch --enable-streaming ...

AMS will automatically create a streaming session for the instance. You can find the id of the session as a tag on the instance in the format `session=<id>`.

If you want to to further customise the streaming configuration such as display settings or frame rate, use the corresponding arguments: `--display-size`, `--display-density` and `--fps`. For example, to create an instance with a 1080p resolution, a frame rate of 60 and a DPI of 120, run:

amc launch --enable-streaming --display-size=1920x1080 --display-density=120 --fps=60 ...

### Launch an instance with a specific name

*since 1.22.0*
Expand Down
19 changes: 19 additions & 0 deletions reference/ams-configuration.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,3 +347,22 @@ node:
If set to `true`, the node cannot be scheduled, which prevents
new instances from being launched on it.
deprecated: "No"
agent.api.fingerprint:
type: "string"
default: "-"
description: >-
Fingerprint of certificate in the AMS trust store which is
trusted when communicating with the stream agent.
deprecated: "No"
agent.api.token:
type: "string"
default: "-"
description: >-
Token to be used for API authentication with stream agent.
deprecated: "No"
agent.api.url:
type: "string"
default: "-"
description: >-
URL for stream agent API endpoint.
deprecated: "No"