More work on params, docstrings
[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, credential_name):
22 """Remove a credential for this cloud.
23
24 :param str credential_name: Name of the credential to remove
25
26 """
27 pass
28
29 def bootstrap(
30 self, controller_name, region=None, agent_version=None,
31 auto_upgrade=False, bootstrap_constraints=None,
32 bootstrap_series=None, config=None, constraints=None,
33 credential=None, default_model=None, keep_broken=False,
34 metadata_source=None, no_gui=False, to=None,
35 upload_tools=False):
36
37 """Initialize a cloud environment.
38
39 :param str controller_name: Name of controller to create
40 :param str region: Cloud region in which to bootstrap
41 :param str agent_version: Version of tools to use for Juju agents
42 :param bool auto_upgrade: Upgrade to latest path release tools on first
43 bootstrap
44 :param :class:`juju.Constraints` bootstrap_constraints: Constraints
45 for the bootstrap machine
46 :param str bootstrap_series: Series of the bootstrap machine
47 :param dict config: Controller configuration
48 :param :class:`juju.Constraints` constraints: Default constraints for
49 all future workload machines
50 :param :class:`juju.Credential` credential: Credential to use when
51 bootstrapping
52 :param str default_model: Name to give the default model
53 :param bool keep_broken: Don't destroy model if bootstrap fails
54 :param str metadata_source: Local path to use as tools and/or metadata
55 source
56 :param bool no_gui: Don't install the Juju GUI in the controller when
57 bootstrapping
58 :param str to: Placement directive for bootstrap node (typically used
59 with MAAS)
60 :param bool upload_tools: Upload local version of tools before
61 bootstrapping
62
63 """
64 pass
65
66 def set_default_credential(self):
67 """Set the default credentials for this cloud.
68
69 """
70 pass
71
72 def set_default_region(self):
73 """Set the default region for this cloud.
74
75 """
76 pass