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
// Copyright 2018 Dmitry Tantsur <divius.inside@gmail.com> // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Cloud API. #[allow(unused_imports)] use fallible_iterator::FallibleIterator; #[allow(unused_imports)] use super::{Error, ErrorKind, Result}; use super::auth::AuthMethod; #[cfg(feature = "compute")] use super::compute::{Flavor, FlavorQuery, FlavorSummary, Server, ServerQuery, ServerSummary}; #[cfg(feature = "image")] use super::image::{Image, ImageQuery}; #[cfg(feature = "network")] use super::network::{Network, NetworkQuery}; use super::session::Session; #[allow(unused_imports)] use super::utils::ResultExt; /// OpenStack cloud API. /// /// Provides high-level API for working with OpenStack clouds. #[derive(Debug, Clone)] pub struct Cloud { session: Session } impl Cloud { /// Create a new cloud object with a given authentication plugin. /// /// See (auth module)[auth/index.html) for details on how to authenticate /// against OpenStack clouds. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// ``` pub fn new<Auth: AuthMethod + 'static>(auth_method: Auth) -> Cloud { Cloud { session: Session::new(auth_method) } } /// Convert this cloud into one using the given endpoint interface. pub fn with_endpoint_interface<S>(self, endpoint_interface: S) -> Cloud where S: Into<String> { Cloud { session: self.session.with_endpoint_interface(endpoint_interface) } } /// Refresh this `Cloud` object (renew token, refetch service catalog, etc). pub fn refresh(&mut self) -> Result<()> { self.session.auth_method_mut().refresh() } /// `Session` used with this `Cloud` object. pub fn session(&self) -> &Session { &self.session } /// Build a query against flavor list. /// /// The returned object is a builder that should be used to construct /// the query. #[cfg(feature = "compute")] pub fn find_flavors(&self) -> FlavorQuery { FlavorQuery::new(&self.session) } /// Build a query against image list. /// /// The returned object is a builder that should be used to construct /// the query. #[cfg(feature = "image")] pub fn find_images(&self) -> ImageQuery { ImageQuery::new(&self.session) } /// Build a query against network list. /// /// The returned object is a builder that should be used to construct /// the query. #[cfg(feature = "network")] pub fn find_networks(&self) -> NetworkQuery { NetworkQuery::new(&self.session) } /// Build a query against server list. /// /// The returned object is a builder that should be used to construct /// the query. /// /// # Example /// /// Sorting servers by `access_ip_v4` and getting first 5 results: /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let sorting = openstack::compute::ServerSortKey::AccessIpv4; /// let server_list = os.find_servers() /// .sort_by(openstack::Sort::Asc(sorting)).with_limit(5) /// .all().expect("Unable to fetch servers"); /// ``` #[cfg(feature = "compute")] pub fn find_servers(&self) -> ServerQuery { ServerQuery::new(&self.session) } /// Find a flavor by its name or ID. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server = os.get_flavor("m1.medium").expect("Unable to get a flavor"); /// ``` #[cfg(feature = "compute")] pub fn get_flavor<Id: Into<String>>(&self, id_or_name: Id) -> Result<Flavor> { let s = id_or_name.into(); Flavor::new(&self.session, &s).if_not_found_then(|| { self.find_flavors().into_iter() .filter(|item| item.name() == &s).take(2) .collect::<Vec<FlavorSummary>>().and_then(|mut items| { if items.len() > 1 { Err(Error::new(ErrorKind::TooManyItems, "Too many flavors with this name")) } else { match items.pop() { Some(item) => item.details(), None => Err(Error::new( ErrorKind::ResourceNotFound, "No flavors with this name or ID")) } } }) }) } /// Find an image by its name or ID. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server = os.get_image("centos7").expect("Unable to get a image"); /// ``` #[cfg(feature = "image")] pub fn get_image<Id: Into<String>>(&self, id_or_name: Id) -> Result<Image> { let s = id_or_name.into(); Image::new(&self.session, &s).if_not_found_then(|| { self.find_images().with_name(s).one() }) } /// Find an network by its name or ID. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server = os.get_network("centos7").expect("Unable to get a network"); /// ``` #[cfg(feature = "network")] pub fn get_network<Id: Into<String>>(&self, id_or_name: Id) -> Result<Network> { let s = id_or_name.into(); Network::new(&self.session, &s).if_not_found_then(|| { self.find_networks().with_name(s).one() }) } /// Find a server by its name or ID. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server = os.get_server("8a1c355b-2e1e-440a-8aa8-f272df72bc32") /// .expect("Unable to get a server"); /// ``` #[cfg(feature = "compute")] pub fn get_server<Id: Into<String>>(&self, id_or_name: Id) -> Result<Server> { let s = id_or_name.into(); Server::new(&self.session, &s).if_not_found_then(|| { self.find_servers().with_name(s.clone()).into_iter() .filter(|srv| srv.name() == &s).take(2) .collect::<Vec<ServerSummary>>().and_then(|mut srvs| { if srvs.len() > 1 { Err(Error::new(ErrorKind::TooManyItems, "Too many servers with this name")) } else { match srvs.pop() { Some(srv) => srv.details(), None => Err(Error::new( ErrorKind::ResourceNotFound, "No servers with this name or ID")) } } }) }) } /// List all flavors. /// /// This call can yield a lot of results, use the /// [find_flavors](#method.find_flavors) call to limit the number of /// flavors to receive. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server_list = os.list_flavors().expect("Unable to fetch flavors"); /// ``` #[cfg(feature = "compute")] pub fn list_flavors(&self) -> Result<Vec<FlavorSummary>> { self.find_flavors().all() } /// List all images. /// /// This call can yield a lot of results, use the /// [find_images](#method.find_images) call to limit the number of /// images to receive. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server_list = os.list_images().expect("Unable to fetch images"); /// ``` #[cfg(feature = "image")] pub fn list_images(&self) -> Result<Vec<Image>> { self.find_images().all() } /// List all networks. /// /// This call can yield a lot of results, use the /// [find_networks](#method.find_networks) call to limit the number of /// networks to receive. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server_list = os.list_networks().expect("Unable to fetch networks"); /// ``` #[cfg(feature = "network")] pub fn list_networks(&self) -> Result<Vec<Network>> { self.find_networks().all() } /// List all servers. /// /// This call can yield a lot of results, use the /// [find_servers](#method.find_servers) call to limit the number of /// servers to receive. /// /// # Example /// /// ```rust,no_run /// use openstack; /// /// let auth = openstack::auth::from_env().expect("Unable to authenticate"); /// let os = openstack::Cloud::new(auth); /// let server_list = os.list_servers().expect("Unable to fetch servers"); /// ``` #[cfg(feature = "compute")] pub fn list_servers(&self) -> Result<Vec<ServerSummary>> { self.find_servers().all() } } impl From<Session> for Cloud { fn from(value: Session) -> Cloud { Cloud { session: value } } } impl From<Cloud> for Session { fn from(value: Cloud) -> Session { value.session } }