Crate fluvio_cluster[][src]

Functionality for installing, managing, and deleting Fluvio clusters.

The primary use of this crate is to install Fluvio clusters on Kubernetes using a ClusterInstaller, which provides a fluid interface for cluster specification.

Example

To install a basic Fluvio cluster, just do the following:

use fluvio_cluster::{ClusterInstaller, ClusterConfig, ClusterError};
let config = ClusterConfig::builder("0.7.0-alpha.1").build()?;
let installer = ClusterInstaller::from_config(config)?;
installer.install_fluvio().await?;

Structs

ClusterChecker

Manages all cluster check operations

ClusterConfig

Describes how to install Fluvio onto Kubernetes

ClusterConfigBuilder

Builder for ClusterConfig.

ClusterInstaller

Allows installing Fluvio on a Kubernetes cluster

ClusterUninstaller

Uninstalls different flavors of fluvio

LocalConfig

Describes how to install Fluvio locally

LocalConfigBuilder

Builder for LocalConfig.

LocalInstaller

Install fluvio cluster locally

StartStatus

The result of a successful startup of a Fluvio cluster

SysConfig

Configuration options for installing Fluvio system charts

SysConfigBuilder

Builder for SysConfig.

SysInstaller

Installs or upgrades the Fluvio system charts

Enums

ChartLocation

Distinguishes between a Local and Remote helm chart

CheckFailed

A description of a failed check

CheckStatus

When a check completes without error, it either passes or fails

ClusterError

The types of errors that can occur during cluster management

HelmError
K8InstallError

Errors that may occur while trying to install Fluvio on Kubernetes

LocalInstallError

Errors that may occur while trying to install Fluvio locally

RecoverableCheck

A type of check failure which may be automatically recovered from

SysInstallError

Errors that may occur while trying to install Fluvio system charts

UninstallError

Errors that may occur while trying to unintsall Fluvio

UnrecoverableCheck

A type of check failure which is not recoverable

Traits

CheckSuggestion

Allows checks to suggest further action

Type Definitions

CheckResult

The outcome of a check: it was either successfully performed, or it errored

CheckResults

A collection of the successes, failures, and errors of running checks

CheckStatuses

A collection of the successes, failures, and errors of running checks