Struct fluvio_cluster::LocalConfigBuilder

pub struct LocalConfigBuilder { /* fields omitted */ }

Builder for LocalConfig.

Implementations

impl LocalConfigBuilder

pub fn log_dir<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Sets the application log directory.

Example

let config = builder
    .log_dir("/tmp")
    .build()?;

pub fn data_dir<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Sets the data-log directory. This is where streaming data is stored.

Example

let config = builder
    .data_dir("/tmp/fluvio")
    .build()?;

pub fn rust_log<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Sets the RUST_LOG environment variable for the installation.

Example

let config = builder
    .rust_log("debug")
    .build()?;

pub fn spu_replicas(&mut self, value: u16) -> &mut Self

Sets the number of SPU replicas that should be provisioned. Defaults to 1.

Example

let config = builder
    .spu_replicas(2)
    .build()?;

pub fn chart_version<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The version of the Fluvio system chart to install

This is the only required field that does not have a default value.

Example

let config = builder
    .chart_version("0.7.0-alpha.1")
    .build()?;

pub fn install_sys(&mut self, value: bool) -> &mut Self

Whether to install the fluvio-sys chart in the full installation.

Defaults to true.

Example

If you want to disable installing the system chart, you can do this

let config = builder
    .install_sys(false)
    .build()?;

pub fn skip_checks(&mut self, value: bool) -> &mut Self

Whether to skip pre-install checks before installation.

Defaults to false.

Example

let config = builder
    .skip_checks(false)
    .build()?;

pub fn render_checks(&mut self, value: bool) -> &mut Self

Whether to render pre-install checks to stdout as they are performed.

Defaults to false.

Example

let config = builder
    .render_checks(true)
    .build()?;

impl LocalConfigBuilder

pub fn build(&self) -> Result<LocalConfig, ClusterError>

Creates a LocalConfig with the current configuration.

Example

The simplest flow to create a ClusterConfig looks like:

let config: LocalConfig = LocalConfig::builder("0.7.0-alpha.1").build()?;

pub fn tls<C: Into<TlsPolicy>, S: Into<TlsPolicy>>(
    &mut self,
    client: C,
    server: S
) -> &mut Self

Sets the TLS Policy that the client and server will use to communicate.

By default, these are set to TlsPolicy::Disabled.

Example

use std::path::PathBuf;
use fluvio::config::TlsPaths;
use fluvio_cluster::LocalInstaller;

let cert_path = PathBuf::from("/tmp/certs");
let client = TlsPaths {
    domain: "fluvio.io".to_string(),
    ca_cert: cert_path.join("ca.crt"),
    cert: cert_path.join("client.crt"),
    key: cert_path.join("client.key"),
};
let server = TlsPaths {
    domain: "fluvio.io".to_string(),
    ca_cert: cert_path.join("ca.crt"),
    cert: cert_path.join("server.crt"),
    key: cert_path.join("server.key"),
};

let config = LocalConfig::builder("0.7.0-alpha.1")
    .tls(client, server)
    .build()?;

pub fn local_chart<S: Into<PathBuf>>(
    &mut self,
    local_chart_location: S
) -> &mut Self

Sets a local helm chart location to search for Fluvio charts.

This is often desirable when developing for Fluvio locally and making edits to the chart. When using this option, the argument is expected to be a local filesystem path. The path given is expected to be the parent directory of both the fluvio-app and fluvio-sys charts.

This option is mutually exclusive from with_remote_chart; if both are used, the latest one defined is the one that's used.

Example

let config = builder
    .local_chart("./k8-util/helm")
    .build()?;

Trait Implementations

impl Clone for LocalConfigBuilder

fn clone(&self) -> LocalConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LocalConfigBuilder

fn default() -> LocalConfigBuilder

Returns the "default value" for a type.