Struct fluvio_cluster::ClusterInstaller

pub struct ClusterInstaller { /* fields omitted */ }

Allows installing Fluvio on a Kubernetes cluster

Fluvio's Kubernetes components are distributed as Helm Charts, which allow them to be easily installed on any Kubernetes cluster. A ClusterInstaller takes care of installing all of the pieces in the right order, with sane defaults.

Example

If you want to try out Fluvio on Kubernetes, you can use Minikube as an installation target. This is the default target that the ClusterInstaller uses, so it doesn't require any complex setup.

use fluvio_cluster::ClusterInstaller;
let installer = ClusterInstaller::new()
    .build()
    .expect("should initialize installer");

// Installing Fluvio is asynchronous, so you'll need an async runtime
let result = fluvio_future::task::run_block_on(async {
    installer.install_fluvio().await
});

Implementations

impl ClusterInstaller

pub fn new() -> ClusterInstallerBuilder

Creates a default ClusterInstallerBuilder which can build a ClusterInstaller

Example

The easiest way to build a ClusterInstaller is as follows:

use fluvio_cluster::ClusterInstaller;
let installer = ClusterInstaller::new().build().unwrap();

Building a ClusterInstaller may fail if there is trouble connecting to Kubernetes or if the helm executable is not locally installed.

You may also set custom installation options before calling .build(). For example, if you wanted to specify a custom namespace and RUST_LOG, you could use with_namespace and with_rust_log. See ClusterInstallerBuilder for the full set of options.

use fluvio_cluster::ClusterInstaller;
let installer = ClusterInstaller::new()
    .with_namespace("my_namespace")
    .with_rust_log("debug")
    .build()
    .expect("should build ClusterInstaller");

pub fn versions() -> Result<Vec<Chart>, ClusterError>

Get all the available versions of fluvio chart

pub fn sys_charts() -> Result<Vec<InstalledChart>, ClusterError>

Get installed system chart

pub async fn install_fluvio<'_>(&'_ self) -> Result<String, ClusterError>

Installs Fluvio according to the installer's configuration

Returns the external address of the new cluster's SC

Trait Implementations

impl Debug for ClusterInstaller

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

Formats the value using the given formatter.