Merge pull request #78 from TechConsult/constants_redone

Constants redone

Author: Trdls

README.md

@@ -68,7 +68,7 @@ You must take this into account in your automations.
 ```python
 
 import upcloud_api
-from upcloud_api import Server, Storage, ZONE, login_user_block
+from upcloud_api import Server, Storage, login_user_block
 
 manager = upcloud_api.CloudManager('api_user', 'password')
 manager.authenticate()
@@ -85,11 +85,11 @@ cluster = {
         core_number=1, # CPU cores
         memory_amount=1024, # RAM in MB
         hostname='web1.example.com',
-        zone=ZONE.London, # ZONE.Helsinki and ZONE.Chicago available also
+        zone='uk-lon1', # All available zones with ids can be retrieved by using manager.get_zones()
         storage_devices=[
-            # OS: Ubuntu 14.04 from template
+            # OS: 01000000-0000-4000-8000-000030060200, all available os templates can be retrieved by calling manager.get_templates()
             # default tier: maxIOPS, the 100k IOPS storage backend
-            Storage(os='Ubuntu 14.04', size=10),
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10),
             # secondary storage, hdd for reduced cost
             Storage(size=100, tier='hdd')
         ],
@@ -99,19 +99,19 @@ cluster = {
         core_number=1,
         memory_amount=1024,
         hostname='web2.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         storage_devices=[
-            Storage(os='Ubuntu 14.04', size=10),
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10),
             Storage(size=100, tier='hdd'),
         ],
         login_user=login_user
     ),
     'db': Server(
         plan='2xCPU-4GB', # use a preconfigured plan, instead of custom
         hostname='db.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         storage_devices=[
-            Storage(os='Ubuntu 14.04', size=10),
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10),
             Storage(size=100),
         ],
         login_user=login_user
@@ -120,9 +120,9 @@ cluster = {
         core_number=2,
         memory_amount=1024,
         hostname='balancer.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         storage_devices=[
-            Storage(os='Ubuntu 14.04', size=10)
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10)
         ],
         login_user=login_user
     )
@@ -187,7 +187,7 @@ clone = Server(
     core_number=1,
     memory_amount=1024,
     hostname='cloned.server',
-    zone=ZONE.Helsinki,
+    zone='fi-hel1',
     storage_devices=[
         Storage(
             uuid='012bea57-0f70-4194-82d0-b3d25f4a018b',

docs/CloudManager.md

@@ -26,7 +26,7 @@ manager.get_account()
 
 # Zone
 
-Zones are already hardcoded as Enums in `upcloud_api.ZONE`. However, they can be queried from the API too.
+Zones can be queried from the api.
 
 ```python
 

docs/Server.md

@@ -3,7 +3,6 @@ The examples use the following:
 import upcloud_api
 from upcloud_api import Server
 from upcloud_api import Storage
-from upcloud_api import ZONE
 
 manager = upcloud_api.CloudManager("username", "password")
 ```
@@ -53,9 +52,9 @@ server = Server(
 			core_number = 1,
 			memory_amount = 1024,
 			hostname = "web1.example.com",
-			zone = ZONE.London,
+			zone = 'uk-lon1',
 			storage_devices = [
-				Storage(os = "Ubuntu 14.04", size=10),
+				Storage(os = "01000000-0000-4000-8000-000030060200", size=10),
 				Storage(size=10, tier="hdd")
 			])
 
@@ -64,17 +63,7 @@ manager.create_server( server )
 ```
 
 Currently available Storage operating systems are the following UpCloud public templates:
-
-```python
-# upcloud_api/tools.py
-
-Operating Systems:
-	"CentOS 6.5", "CentOS 7.0",
-	"Debian 7.8", "Ubuntu 12.04", "Ubuntu 14.04",
-	"Windows 2003", "Windows 2008", "Windows 2012"
-
-```
-
+Valid Operating Systems cam be retrieved with 'manager.get_templates()'. More information on this method can be found in storage_mixin documentation.
 
 Please refer to the [API documentation](https://www.upcloud.com/static/downloads/upcloud-apidoc-1.1.1.pdf) for the allowed Server attributes.
 
@@ -110,7 +99,7 @@ A Server's Storages can be attached and detached with `.add_storage()` and `.rem
 ```python
 
 # attach
-storage = manager.create_storage( size=100, zone=ZONE.Helsinki )
+storage = manager.create_storage( size=100, zone='fi-hel1' )
 server.add_storage(storage)
 
 # detach

docs/Storage.md

@@ -3,7 +3,6 @@ The code examples use the following:
 ```python
 import upcloud_api
 from upcloud_api import Storage
-from upcloud_api import ZONE
 
 manager = upcloud_api.CloudManager("username", "password")
 ```
@@ -24,7 +23,7 @@ Tiers:
 
 ### Templates
 
-Public templates such as the Ubuntu 14.04 can be cloned by anyone to get a pre-installed server image that is immediately ready to go. A user can also create private templates for themselves out of any storage. Storages can be cloned from templates during server creation.
+Public templates such as the 01000000-0000-4000-8000-000030060200 can be cloned by anyone to get a pre-installed server image that is immediately ready to go. A user can also create private templates for themselves out of any storage. Storages can be cloned from templates during server creation.
 
 ## List / Get
 
@@ -54,9 +53,9 @@ Storage can be created with the CloudManager's `.create_storage(size=10, tier="m
 storage1 = manager.create_storage(	size=10,
 									tier="maxiops",
 									title="my storage disk",
-									zone=ZONE.Helsinki )
+									zone='fi-hel1' )
 
-storage2 = manager.create_storage(100, zone=ZONE.Helsinki)
+storage2 = manager.create_storage(100, zone='fi-hel1')
 
 ```
 
@@ -91,7 +90,7 @@ Method requires title and zone to be passed while tier is optional.
 
 ```python
 
-storage_clone = storage.clone(title='title of storage clone', zone=ZONE.Helsinki, tier=None)
+storage_clone = storage.clone(title='title of storage clone', zone='fi-hel1', tier=None)
 
 ```
 

docs/server-mixin.md

@@ -43,9 +43,9 @@ def create_server(self, server):
 	server1 = Server( core_number = 1,
 				memory_amount = 1024,
 				hostname = "my.example.1",
-				zone = ZONE.London,
+				zone = "uk-lon1",
 				storage_devices = [
-					Storage(os = "Ubuntu 14.04", size=10, tier=maxiops, title='The OS drive'),
+					Storage(os="01000000-0000-4000-8000-000030060200", size=10, tier=maxiops, title='The OS drive'),
 					Storage(size=10),
 					Storage()
 				title = "My Example Server"
@@ -56,11 +56,8 @@ def create_server(self, server):
 	- size defaults to 10,
 	- title defaults to hostname + " OS disk" and hostname + " storage disk id" (id is a running starting from 1)
 	- tier defaults to maxiops
-	- valid operating systems are:
-		"CentOS 6.5", "CentOS 7.0"
-		"Debian 7.8"
-		"Ubuntu 12.04", "Ubuntu 14.04"
-		"Windows 2003","Windows 2008" ,"Windows 2012"
+	- valid operating systems with names and ids can be retrieved by calling manager.get_templates():
+		More detailed documentation of this method can be found in storage_mixin documentation.
 
 	"""
 ```

docs/storage-mixin.md

@@ -29,6 +29,13 @@ def get_storage(self, UUID):
 	"""
 ```
 
+```python
+def get_templates(self):
+	"""
+	Return a list of Storages that are templates in a dict with title as key and uuid as value.
+	"""
+```
+
 ```python
 def create_storage(self, size=10, tier="maxiops", title="Storage disk", zone="fi-hel1"):
 	"""

test/helpers/infra.py

@@ -3,7 +3,7 @@
 from __future__ import division
 from __future__ import absolute_import
 
-from upcloud_api import CloudManager, Storage, FirewallRule, ZONE, Tag, IPAddress
+from upcloud_api import CloudManager, Storage, FirewallRule, Tag, IPAddress
 from upcloud_api.server import Server, login_user_block
 
 
@@ -12,21 +12,21 @@
         core_number=1,
         memory_amount=1024,
         hostname='web1.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         password_delivery='none',
         storage_devices=[
-            Storage(os='Ubuntu 14.04', size=10),
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10),
             Storage(size=10, tier='maxiops')
         ]),
 
     'web2': Server(
         core_number=1,
         memory_amount=1024,
         hostname='web2.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         password_delivery='none',
         storage_devices=[
-            Storage(os='Ubuntu 14.04', size=10),
+            Storage(os='01000000-0000-4000-8000-000030060200', size=10),
             Storage(size=10, tier='maxiops'),
         ],
         ip_addresses=[
@@ -37,10 +37,10 @@
         core_number=1,
         memory_amount=1024,
         hostname='db.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         password_delivery='none',
         storage_devices=[
-            Storage(os='CentOS 7.6', size=10),
+            Storage(os='01000000-0000-4000-8000-000050010300', size=10),
             Storage(size=10),
         ],
         login_user=login_user_block('testuser', ['ssh-rsa AAAAB3NzaC1yc2EAA[...]ptshi44x user@some.host'], True),
@@ -50,7 +50,7 @@
     'lb': Server(
         plan= '1xCPU-1GB',
         hostname='balancer.example.com',
-        zone=ZONE.London,
+        zone='uk-lon1',
         password_delivery='none',
         storage_devices=[
             Storage(os='Debian 10.0', size=30)

test/helpers/infra_helpers.py

@@ -3,7 +3,7 @@
 from __future__ import division
 from __future__ import absolute_import
 
-from upcloud_api import ZONE, Tag
+from upcloud_api import Tag
 
 
 def create_cluster(manager, cluster):
@@ -52,7 +52,7 @@ def server_test(manager, server):
 
     server.add_ip()
 
-    storage = manager.create_storage(size=10, tier='maxiops', zone=ZONE.London)
+    storage = manager.create_storage(size=10, tier='maxiops', zone='uk-lon1')
     server.add_storage(storage)
 
     server.start()