Skip to main content

Request

Enum Request 

Source
pub enum Request {
Show 28 variants Add(AddRequest), Remove(RemoveRequest), Configure(ConfigureRequest), Lifecycle(LifecycleRequest), Upgrade(UpgradeRequest), List, Get { service: String, }, Diff { service: String, }, Backups { service: String, }, Revert { service: String, at: Option<String>, }, Search { query: Option<String>, registry: Option<String>, }, Registries, AddRegistry { name: String, url: String, }, RemoveRegistry { name: String, }, Doctor, Backup { service: String, }, Restore { service: String, snapshot: String, }, Snapshots { service: String, }, BackupStatus, ConfigureBackup { backend: BackupBackendSpec, password: Option<String>, }, SetBackupEnrolled { service: String, enabled: bool, }, ServiceDef { service: String, registry: Option<String>, }, ConfigureView { service: String, }, Reconcile { services: Vec<String>, dry_run: bool, }, ListTests, RunTest { name: String, }, TestState, RemoveTestResults { name: Option<String>, },
}
Expand description

One request to the agent. Adjacently tagged so it maps straight onto a JSON-RPC method + params: {"method":"add","params":{...}}, {"method":"list"}.

Variants§

§

Add(AddRequest)

Install and start a service.

§

Remove(RemoveRequest)

Remove a service (optionally purging its data).

§

Configure(ConfigureRequest)

Re-render an installed service with a changed integration set.

§

Lifecycle(LifecycleRequest)

Start or stop an installed service.

§

Upgrade(UpgradeRequest)

Upgrade an installed service to the registry’s current version.

§

List

List every service (installed + orphan) with live status.

§

Get

One service’s current view.

Fields

§service: String
§

Diff

What an upgrade would change for a service (read-only).

Fields

§service: String
§

Backups

The pre-upgrade snapshots available to revert to, newest first.

Fields

§service: String
§

Revert

Restore a service from a pre-upgrade snapshot (latest if at is None).

Fields

§service: String
§

Search

Search a registry for installable services (default registry if unset).

Fields

§registry: Option<String>
§

Registries

List the configured registries.

§

AddRegistry

Add a custom registry.

Fields

§name: String
§

RemoveRegistry

Remove a custom registry.

Fields

§name: String
§

Doctor

Run the diagnostics ryra-doctor runs.

§

Backup

Take a backup snapshot of a (backup-enabled) service.

Fields

§service: String
§

Restore

Restore a service’s data from a restic snapshot (“latest” for newest).

Fields

§service: String
§snapshot: String
§

Snapshots

List a service’s restic data snapshots, newest first (ryra backup list).

Fields

§service: String
§

BackupStatus

The effective backup configuration + enrolled services (ryra backup status).

§

ConfigureBackup

Point backups at a backend: init the restic repo and persist [backup] (ryra backup configure). password is the restic key; when absent the engine reuses the existing key or generates a fresh one.

Fields

§password: Option<String>
§

SetBackupEnrolled

Opt a service in or out of backups.

Fields

§service: String
§enabled: bool
§

ServiceDef

The installable env/group/choice schema for a registry service (default registry if registry is unset).

Fields

§service: String
§registry: Option<String>
§

ConfigureView

The configure view (schema + current selections + .env) for an installed service.

Fields

§service: String
§

Reconcile

Propagate the current global config into installed services (ryra configure --apply). Empty services = every installed service whose env would change; dry_run previews without writing/restarting.

Fields

§services: Vec<String>
§dry_run: bool
§

ListTests

Discover the registry’s test suites (ryra test search).

§

RunTest

Run one registry test by name on the host (ryra test <name>).

Fields

§name: String
§

TestState

Local test sandbox state: installed services + last results (ryra test list).

§

RemoveTestResults

Delete stored results for one test, or all tests when name is None (ryra test remove).

Fields

Trait Implementations§

Source§

impl Clone for Request

Source§

fn clone(&self) -> Request

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Request

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Request

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Request

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.