Filling in params, docstrings (wip)
[osm/N2VC.git] / juju / cloud.py
1 class Cloud(object):
2 """Cloud
3
4 :ivar name: Name of the cloud
5
6 """
7 def add_credential(self, credential):
8 """Add or replaces credentials for this cloud.
9
10 :param `juju.Credential` credential: The Credential to add
11
12 """
13 pass
14
15 def get_credentials(self):
16 """Return list of all credentials for this cloud.
17
18 """
19 pass
20
21 def remove_credential(self):
22 """Remove a credential for this cloud.
23
24 """
25 pass
26
27 def bootstrap(
28 self, controller_name, region=None, agent_version=None,
29 auto_upgrade=False, bootstrap_constraints=None,
30 bootstrap_series=None, config=None, constraints=None,
31 credential=None, default_model=None, keep_broken=False,
32 metadata_source=None, no_gui=False, to=None,
33 upload_tools=False):
34
35 """Initialize a cloud environment.
36
37 :param str controller_name: Name of controller to create
38 :param str region: Cloud region in which to bootstrap
39 :param str agent_version: Version of tools to use for Juju agents
40 :param bool auto_upgrade: Upgrade to latest path release tools on first
41 bootstrap
42 :param :class:`juju.Constraints` bootstrap_constraints: Constraints
43 for the bootstrap machine
44 :param str bootstrap_series: Series of the bootstrap machine
45 :param dict config: Controller configuration
46 :param :class:`juju.Constraints` constraints: Default constraints for
47 all future workload machines
48 :param :class:`juju.Credential` credential: Credential to use when
49 bootstrapping
50 :param str default_model: Name to give the default model
51 :param bool keep_broken: Don't destroy model if bootstrap fails
52 :param str metadata_source: Local path to use as tools and/or metadata
53 source
54 :param bool no_gui: Don't install the Juju GUI in the controller when
55 bootstrapping
56 :param str to: Placement directive for bootstrap node (typically used
57 with MAAS)
58 :param bool upload_tools: Upload local version of tools before
59 bootstrapping
60
61 """
62 pass
63
64 def set_default_credential(self):
65 """Set the default credentials for this cloud.
66
67 """
68 pass
69
70 def set_default_region(self):
71 """Set the default region for this cloud.
72
73 """
74 pass