1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
use std::convert::TryFrom;
use std::fmt::Debug;
use std::io::Error as IoError;
use std::io::ErrorKind;
use futures_util::{Stream, StreamExt};
use tracing::{debug, trace, instrument};
use anyhow::{Result, anyhow};
use fluvio_protocol::{Decoder, Encoder};
use fluvio_protocol::api::{Request, RequestMessage};
use fluvio_future::net::DomainConnector;
use fluvio_sc_schema::objects::{
DeleteRequest, ObjectApiCreateRequest, ObjectApiDeleteRequest, ObjectApiListRequest,
ObjectApiWatchRequest, Metadata, ListFilter, WatchRequest, WatchResponse, CreateRequest,
CommonCreateRequest,
};
use fluvio_sc_schema::{AdminSpec, DeletableAdminSpec, CreatableAdminSpec, TryEncodableFrom};
use fluvio_socket::{ClientConfig, VersionedSerialSocket, SerialFrame, MultiplexerSocket};
use crate::FluvioConfig;
use crate::metadata::objects::{ListResponse, ListRequest};
use crate::config::ConfigFile;
use crate::sync::MetadataStores;
/// An interface for managing a Fluvio cluster
///
/// Most applications will not require administrator functionality. The
/// `FluvioAdmin` interface is used to create, edit, and manage Topics
/// and other operational items. Think of the difference between regular
/// clients of a Database and its administrators. Regular clients may be
/// applications which are reading and writing data to and from tables
/// that exist in the database. Database administrators would be the
/// ones actually creating, editing, or deleting tables. The same thing
/// goes for Fluvio administrators.
///
/// If you _are_ writing an application whose purpose is to manage a
/// Fluvio cluster for you, you can gain access to the `FluvioAdmin`
/// client via the regular [`Fluvio`] client, or through the [`connect`]
/// or [`connect_with_config`] functions.
///
/// # Example
///
/// Note that this may fail if you are not authorized as a Fluvio
/// administrator for the cluster you are connected to.
///
/// ```no_run
/// # use fluvio::{Fluvio, FluvioError};
/// # async fn do_get_admin(fluvio: &mut Fluvio) -> Result<(), FluvioError> {
/// let admin = fluvio.admin().await;
/// # Ok(())
/// # }
/// ```
///
/// [`Fluvio`]: ./struct.Fluvio.html
/// [`connect`]: ./struct.FluvioAdmin.html#method.connect
/// [`connect_with_config`]: ./struct.FluvioAdmin.html#method.connect_with_config
pub struct FluvioAdmin {
socket: VersionedSerialSocket,
#[allow(dead_code)]
metadata: MetadataStores,
}
impl FluvioAdmin {
pub(crate) fn new(socket: VersionedSerialSocket, metadata: MetadataStores) -> Self {
Self { socket, metadata }
}
/// Creates a new admin connection using the current profile from `~/.fluvio/config`
///
/// This will attempt to read a Fluvio cluster configuration from
/// your `~/.fluvio/config` file, or create one with default settings
/// if you don't have one. If you want to specify a configuration,
/// see [`connect_with_config`] instead.
///
/// The admin interface requires you to have administrator privileges
/// on the cluster which you are connecting to. If you don't have the
/// appropriate privileges, this connection will fail.
///
/// # Example
///
/// ```no_run
/// # use fluvio::FluvioAdmin;
/// # async fn do_connect() -> anyhow::Result<()> {
/// let admin = FluvioAdmin::connect().await?;
/// # Ok(())
/// # }
/// ```
///
/// [`connect_with_config`]: ./struct.FluvioAdmin.html#method.connect_with_config
#[instrument]
pub async fn connect() -> Result<Self> {
let config_file = ConfigFile::load_default_or_new()?;
let cluster_config = config_file.config().current_cluster()?;
Self::connect_with_config(cluster_config).await
}
/// Creates a new admin connection using custom configurations
///
/// The admin interface requires you to have administrator privileges
/// on the cluster which you are connecting to. If you don't have the
/// appropriate privileges, this connection will fail.
///
/// # Example
///
/// ```no_run
/// # use fluvio::FluvioAdmin;
/// use fluvio::config::ConfigFile;
/// # async fn do_connect_with_config() -> anyhow::Result<()> {
/// let config_file = ConfigFile::load_default_or_new()?;
/// let fluvio_config = config_file.config().current_cluster().unwrap();
/// let admin = FluvioAdmin::connect_with_config(fluvio_config).await?;
/// # Ok(())
/// # }
/// ```
#[instrument(skip(config))]
pub async fn connect_with_config(config: &FluvioConfig) -> Result<Self> {
let connector = DomainConnector::try_from(config.tls.clone())?;
let client_config =
ClientConfig::new(&config.endpoint, connector, config.use_spu_local_address);
let inner_client = client_config.connect().await?;
debug!(addr = %inner_client.config().addr(), "connected to cluster");
let (socket, config, versions) = inner_client.split();
if let Some(watch_version) = versions.lookup_version::<ObjectApiWatchRequest>() {
let socket = MultiplexerSocket::shared(socket);
let metadata = MetadataStores::start(socket.clone(), watch_version).await?;
let versioned_socket = VersionedSerialSocket::new(socket, config, versions);
Ok(Self {
socket: versioned_socket,
metadata,
})
} else {
Err(anyhow!("WatchApi version not found"))
}
}
#[instrument(skip(self, request))]
async fn send_receive_admin<R, I>(&self, request: I) -> Result<R::Response>
where
R: Request + Send + Sync,
R: TryEncodableFrom<I>,
{
let version = self
.socket
.lookup_version::<R>()
.ok_or(anyhow!("no version found for: {}", R::API_KEY))?;
let request = R::try_encode_from(request, version)?;
let req_msg = self.socket.new_request(request, Some(version));
self.socket
.send_and_receive(req_msg)
.await
.map_err(|err| err.into())
}
/// Create new object
#[instrument(skip(self, name, dry_run, spec))]
pub async fn create<S>(&self, name: String, dry_run: bool, spec: S) -> Result<()>
where
S: CreatableAdminSpec + Sync + Send,
{
let common_request = CommonCreateRequest {
name,
dry_run,
..Default::default()
};
self.create_with_config(common_request, spec).await
}
#[instrument(skip(self, config, spec))]
pub async fn create_with_config<S>(&self, config: CommonCreateRequest, spec: S) -> Result<()>
where
S: CreatableAdminSpec + Sync + Send,
{
let create_request = CreateRequest::new(config, spec);
debug!("sending create request: {:#?}", create_request);
self.send_receive_admin::<ObjectApiCreateRequest, _>(create_request)
.await?
.as_result()?;
Ok(())
}
/// Delete object by key
/// key is dependent on spec, most are string but some allow multiple types
///
/// For example, to delete a topic:
///
/// ```edition2021
/// use fluvio::Fluvio;
/// use fluvio::metadata::topic::TopicSpec;
///
/// async fn delete_topic(name: String) -> anyhow::Result<()> {
/// let fluvio = Fluvio::connect().await?;
/// let admin = fluvio.admin().await;
/// admin.delete::<TopicSpec>(name).await?;
/// Ok(())
/// }
/// ```
#[instrument(skip(self, key))]
pub async fn delete<S>(&self, key: impl Into<S::DeleteKey>) -> Result<()>
where
S: DeletableAdminSpec + Sync + Send,
{
let delete_request: DeleteRequest<S> = DeleteRequest::new(key.into());
debug!("sending delete request: {:#?}", delete_request);
self.send_receive_admin::<ObjectApiDeleteRequest, _>(delete_request)
.await?
.as_result()?;
Ok(())
}
/// Forcibly delete object by key
/// key is dependent on spec, most are string but some allow multiple types.
///
/// This method allows to delete objects marked as 'system'.
///
/// For example, to delete a system topic:
///
/// ```edition2021
/// use fluvio::Fluvio;
/// use fluvio::metadata::topic::TopicSpec;
///
/// async fn delete_system_topic(name: String) -> anyhow::Result<()> {
/// let fluvio = Fluvio::connect().await?;
/// let admin = fluvio.admin().await;
/// admin.force_delete::<TopicSpec>(name).await?;
/// Ok(())
/// }
/// ```
#[instrument(skip(self, key))]
pub async fn force_delete<S>(&self, key: impl Into<S::DeleteKey>) -> Result<()>
where
S: DeletableAdminSpec + Sync + Send,
{
let delete_request: DeleteRequest<S> = DeleteRequest::with(key.into(), true);
debug!("sending force delete request: {:#?}", delete_request);
self.send_receive_admin::<ObjectApiDeleteRequest, _>(delete_request)
.await?
.as_result()?;
Ok(())
}
/// return all instance of this spec
#[instrument(skip(self))]
pub async fn all<S>(&self) -> Result<Vec<Metadata<S>>>
where
S: AdminSpec,
S::Status: Encoder + Decoder + Debug,
{
self.list_with_params::<S, String>(vec![], false).await
}
/// return all instance of this spec by filter
#[instrument(skip(self, filters))]
pub async fn list<S, F>(&self, filters: Vec<F>) -> Result<Vec<Metadata<S>>>
where
S: AdminSpec,
ListFilter: From<F>,
S::Status: Encoder + Decoder + Debug,
{
self.list_with_params(filters, false).await
}
#[instrument(skip(self, filters))]
pub async fn list_with_params<S, F>(
&self,
filters: Vec<F>,
summary: bool,
) -> Result<Vec<Metadata<S>>>
where
S: AdminSpec,
ListFilter: From<F>,
S::Status: Encoder + Decoder + Debug,
{
let filter_list: Vec<ListFilter> = filters.into_iter().map(Into::into).collect();
let list_request: ListRequest<S> = ListRequest::new(filter_list, summary);
self.list_with_config(list_request).await
}
#[instrument(skip(self, config))]
pub async fn list_with_config<S, F>(&self, config: ListRequest<S>) -> Result<Vec<Metadata<S>>>
where
S: AdminSpec,
ListFilter: From<F>,
S::Status: Encoder + Decoder + Debug,
{
let response = self
.send_receive_admin::<ObjectApiListRequest, _>(config)
.await?;
trace!("list response: {:#?}", response);
response
.downcast()?
.ok_or(anyhow!("downcast error: {s}", s = S::LABEL))
.map(|out: ListResponse<S>| out.inner())
}
/// Watch stream of changes for metadata
/// There is caching, this is just pass through
#[instrument(skip(self))]
pub async fn watch<S>(&self) -> Result<impl Stream<Item = Result<WatchResponse<S>, IoError>>>
where
S: AdminSpec,
S::Status: Encoder + Decoder,
{
// only summary for watch
let watch_request: WatchRequest<S> = WatchRequest::summary();
let version = self
.socket
.lookup_version::<ObjectApiWatchRequest>()
.ok_or(anyhow!(
"no version found watch request {}",
ObjectApiWatchRequest::API_KEY
))?;
let watch_req = ObjectApiWatchRequest::try_encode_from(watch_request, version)?;
let req_msg = RequestMessage::new_request(watch_req);
debug!(api_version = req_msg.header.api_version(), obj = %S::LABEL, "create watch stream");
let inner_socket = self.socket.new_socket();
let stream = inner_socket.create_stream(req_msg, 10).await?;
Ok(stream.map(|respons_result| match respons_result {
Ok(response) => {
let watch_response = response.downcast().map_err(|err| {
IoError::new(ErrorKind::Other, format!("downcast error: {:#?}", err))
})?;
watch_response.ok_or(IoError::new(
ErrorKind::Other,
format!("cannot decoded as {s}", s = S::LABEL),
))
}
Err(err) => Err(IoError::new(
ErrorKind::Other,
format!("socket error {err}"),
)),
}))
}
}
/// API for streaming cached metadata
#[cfg(feature = "unstable")]
mod unstable {
use super::*;
use futures_util::Stream;
use crate::sync::AlwaysNewContext;
use crate::metadata::topic::TopicSpec;
use crate::metadata::partition::PartitionSpec;
use crate::metadata::spu::SpuSpec;
use crate::metadata::store::MetadataChanges;
impl FluvioAdmin {
/// Create a stream that yields updates to Topic metadata
pub fn watch_topics(
&self,
) -> impl Stream<Item = MetadataChanges<TopicSpec, AlwaysNewContext>> {
self.metadata.topics().watch()
}
/// Create a stream that yields updates to Partition metadata
pub fn watch_partitions(
&self,
) -> impl Stream<Item = MetadataChanges<PartitionSpec, AlwaysNewContext>> {
self.metadata.partitions().watch()
}
/// Create a stream that yields updates to SPU metadata
pub fn watch_spus(&self) -> impl Stream<Item = MetadataChanges<SpuSpec, AlwaysNewContext>> {
self.metadata.spus().watch()
}
}
}