Azure Cloudriver

Signed-off-by: Mikel Nelson <github@mikelnelson.net>
powerfulseal · May 20, 2019 · e386f1a · e386f1a
1 parent 636709f
commit e386f1a
Show file tree

Hide file tree

Showing 8 changed files with 440 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ Embrace the inevitable failure. __Embrace The Seal__.
 
 ## Highlights
 
-- works with `OpenStack`, `AWS` and local machines
+- works with `OpenStack`, `AWS`, `Azure`, and local machines
 - speaks `Kubernetes` natively
 - interactive and autonomous, policy-driven mode
 - web interface to interact with PowerfulSeal
@@ -59,11 +59,14 @@ __PowerfulSeal__ works in several modes:
 ```sh
 $ seal interactive --help
 usage: seal interactive [-h] --kubeconfig KUBECONFIG
-                        (--openstack | --aws | --no-cloud)
+                        (--openstack | --aws | --azure | --no-cloud)
                         [--openstack-cloud-name OPENSTACK_CLOUD_NAME]
+                        [--azure-resource-group-name AZURE_RESOURCE_GROUP_NAME]
+                        [--azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME]
                         (-i INVENTORY_FILE | --inventory-kubernetes)
                         [--remote-user REMOTE_USER]
                         [--ssh-allow-missing-host-keys]
+                        [--override-ssh-host OVERRIDE_SSH_HOST]
                         [--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
                         [--ssh-password SSH_PASSWORD]
                         [--use-private-ip]
@@ -78,10 +81,18 @@ Kubernetes settings:
 Cloud settings:
   --openstack           use OpenStack cloud provider
   --aws                 use AWS cloud provider
+  --azure               use Azure cloud provider
   --no-cloud            don't use cloud provider
   --openstack-cloud-name OPENSTACK_CLOUD_NAME
                         optional name of the open stack cloud from your config
                         file to use
+  --azure-resource-group-name AZURE_RESOURCE_GROUP_NAME
+                        optional name of the Azure VM cluster resource group.
+                        Used to determine azure-node-resource-group-name if 
+                        that is not provided.  
+  --azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME
+                        name of the Azure VM cluster node resource group
+                        Required when using Azure cloud provider.
 
 Inventory settings:
    -i INVENTORY_FILE, --inventory-file INVENTORY_FILE
@@ -95,6 +106,10 @@ SSH settings:
                         the of the user for the ssh connections
   --ssh-allow-missing-host-keys
                         Allow connection to hosts not present in known_hosts
+  --override-ssh-host OVERRIDE_SSH_HOST
+                        If you'd like to execute all commands on a different
+                        host (for example for minikube) you can override it
+                        here
   --ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
                         Path to ssh private key
   --ssh-password SSH_PASSWORD
@@ -122,11 +137,14 @@ Autonomous reads the scenarios to execute from the policy file, and runs them:
 ```sh
 $ seal autonomous --help
 usage: seal autonomous [-h] --kubeconfig KUBECONFIG
-                       (--openstack | --aws | --no-cloud)
+                       (--openstack | --aws | --azure | --no-cloud)
                        [--openstack-cloud-name OPENSTACK_CLOUD_NAME]
+                       [--azure-resource-group-name AZURE_RESOURCE_GROUP_NAME]
+                       [--azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME]
                        (-i INVENTORY_FILE | --inventory-kubernetes)
                        [--remote-user REMOTE_USER]
                        [--ssh-allow-missing-host-keys]
+                       [--override-ssh-host OVERRIDE_SSH_HOST]
                        [--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
                        [--ssh-password SSH_PASSWORD]
                        [--use-private-ip]
@@ -146,10 +164,18 @@ Kubernetes settings:
 Cloud settings:
   --openstack           use OpenStack cloud provider
   --aws                 use AWS cloud provider
+  --azure               use Azure cloud provider
   --no-cloud            don't use cloud provider
   --openstack-cloud-name OPENSTACK_CLOUD_NAME
                         optional name of the open stack cloud from your config
                         file to use
+  --azure-resource-group-name AZURE_RESOURCE_GROUP_NAME
+                        optional name of the Azure VM cluster resource group.
+                        Used to determine azure-node-resource-group-name if 
+                        that is not provided.  
+  --azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME
+                        name of the Azure VM cluster node resource group
+                        Required when using Azure cloud provider.
 
 Inventory settings:
   -i INVENTORY_FILE, --inventory-file INVENTORY_FILE
@@ -162,6 +188,10 @@ SSH settings:
                         the of the user for the ssh connections
   --ssh-allow-missing-host-keys
                         Allow connection to hosts not present in known_hosts
+  --override-ssh-host OVERRIDE_SSH_HOST
+                        If you'd like to execute all commands on a different
+                        host (for example for minikube) you can override it
+                        here
   --ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
                         Path to ssh private key
   --ssh-password SSH_PASSWORD
@@ -264,10 +294,13 @@ Instructions on how to use label mode can be found in [LABELS.md](LABELS.md).
 ```sh
 $ seal label --help
 usage: seal label [-h] --kubeconfig KUBECONFIG
-                  (--openstack | --aws | --no-cloud)
+                  (--openstack | --aws | --azure | --no-cloud)
                   [--openstack-cloud-name OPENSTACK_CLOUD_NAME]
+                  [--azure-resource-group-name AZURE_RESOURCE_GROUP_NAME]
+                  [--azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME]
                   (-i INVENTORY_FILE | --inventory-kubernetes)
                   [--remote-user REMOTE_USER] [--ssh-allow-missing-host-keys]
+                  [--override-ssh-host OVERRIDE_SSH_HOST]
                   [--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
                   [--ssh-password SSH_PASSWORD]
                   [--use-private-ip]
@@ -288,10 +321,18 @@ Kubernetes settings:
 Cloud settings:
   --openstack           use OpenStack cloud provider
   --aws                 use AWS cloud provider
+  --azure               use Azure cloud provider
   --no-cloud            don't use cloud provider
   --openstack-cloud-name OPENSTACK_CLOUD_NAME
                         optional name of the open stack cloud from your config
                         file to use
+  --azure-resource-group-name AZURE_RESOURCE_GROUP_NAME
+                        optional name of the Azure VM cluster resource group.
+                        Used to determine azure-node-resource-group-name if 
+                        that is not provided.  
+  --azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME
+                        name of the Azure VM cluster node resource group
+                        Required when using Azure cloud provider.
 
 Inventory settings:
   -i INVENTORY_FILE, --inventory-file INVENTORY_FILE
@@ -304,6 +345,10 @@ SSH settings:
                         the of the user for the ssh connections
   --ssh-allow-missing-host-keys
                         Allow connection to hosts not present in known_hosts
+  --override-ssh-host OVERRIDE_SSH_HOST
+                        If you'd like to execute all commands on a different
+                        host (for example for minikube) you can override it
+                        here
   --ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
                         Path to ssh private key
   --ssh-password SSH_PASSWORD
@@ -346,10 +391,13 @@ Demo mode requires [Heapster](https://github.com/kubernetes/heapster). To run de
 ```sh
 $ seal demo --help
 usage: seal demo [-h] --kubeconfig KUBECONFIG
-                 (--openstack | --aws | --no-cloud)
+                 (--openstack | --aws | --azure | --no-cloud)
                  [--openstack-cloud-name OPENSTACK_CLOUD_NAME]
+                 [--azure-resource-group-name AZURE_RESOURCE_GROUP_NAME]
+                 [--azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME]
                  (-i INVENTORY_FILE | --inventory-kubernetes)
                  [--remote-user REMOTE_USER] [--ssh-allow-missing-host-keys]
+                 [--override-ssh-host OVERRIDE_SSH_HOST]
                  [--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
                  [--ssh-password SSH_PASSWORD]
                  [--use-private-ip]
@@ -371,10 +419,18 @@ Kubernetes settings:
 Cloud settings:
   --openstack           use OpenStack cloud provider
   --aws                 use AWS cloud provider
+  --azure               use Azure cloud provider
   --no-cloud            don't use cloud provider
   --openstack-cloud-name OPENSTACK_CLOUD_NAME
                         optional name of the open stack cloud from your config
                         file to use
+  --azure-resource-group-name AZURE_RESOURCE_GROUP_NAME
+                        optional name of the Azure VM cluster resource group.
+                        Used to determine azure-node-resource-group-name if 
+                        that is not provided.  
+  --azure-node-resource-group-name AZURE_NODE_RESOURCE_GROUP_NAME
+                        name of the Azure VM cluster node resource group
+                        Required when using Azure cloud provider.
 
 Inventory settings:
   -i INVENTORY_FILE, --inventory-file INVENTORY_FILE
@@ -387,6 +443,10 @@ SSH settings:
                         the of the user for the ssh connections
   --ssh-allow-missing-host-keys
                         Allow connection to hosts not present in known_hosts
+  --override-ssh-host OVERRIDE_SSH_HOST
+                        If you'd like to execute all commands on a different
+                        host (for example for minikube) you can override it
+                        here
   --ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
                         Path to ssh private key
   --ssh-password SSH_PASSWORD
@@ -529,6 +589,33 @@ myhost01
 myhost02
 ```
 
+## Cloud Provider Requirements
+
+### SSH
+
+In all cases, the SSH Keys must be set up for SSH Client access of the nodes.  
+
+### Azure
+
+The credentials to connect to Azure may be specified in one of two ways:
+
+1. Supply the full path to an Azure credentials file in the environment variable `AZURE_AUTH_LOCATION`.  
+This is the easiest method.  The credentials file can be generated via `az aks get-credentials -n <cluster name> -g <resouce group> -a -f <desitnation credentials file>`
+2. Supply the individual credentials in the environment variables: `AZURE_SUBSCRIPTION_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`
+
+### AWS
+
+The credentials to connect to AWS are specified the same as for the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
+
+### OpenStack
+
+TBD
+
+### Bare Metal
+
+TBD
+
+
 ## Testing
 
 PowerfulSeal uses [tox](https://github.com/tox-dev/tox) to test with multiple versions on Python. The recommended setup is to install and locally activate the Python versions under `tox.ini` with [pyenv](https://github.com/pyenv/pyenv). 

diff --git a/powerfulseal/cli/__main__.py b/powerfulseal/cli/__main__.py
@@ -31,7 +31,7 @@
 from powerfulseal.web.server import ServerState, start_server, ServerStateLogHandler
 from ..node import NodeInventory
 from ..node.inventory import read_inventory_file_to_dict
-from ..clouddrivers import OpenStackDriver, AWSDriver, NoCloudDriver
+from ..clouddrivers import OpenStackDriver, AWSDriver, NoCloudDriver, AzureDriver
 from ..execute import RemoteExecutor
 from ..k8s import K8sClient, K8sInventory
 from .pscmd import PSCmd
@@ -116,6 +116,11 @@ def add_cloud_options(parser):
         action='store_true',
         help="use AWS cloud provider",
     )
+    cloud_options.add_argument('--azure',
+        default=os.environ.get("AZURE_CLOUD"),
+        action='store_true',
+        help="use Azure cloud provider",
+    )
     cloud_options.add_argument('--no-cloud',
         default=os.environ.get("NO_CLOUD"),
         action='store_true',
@@ -126,6 +131,14 @@ def add_cloud_options(parser):
         default=os.environ.get("OPENSTACK_CLOUD_NAME"),
         help="optional name of the open stack cloud from your config file to use",
     )
+    args.add_argument('--azure-resource-group-name',
+        default=os.environ.get("AZURE_RESORUCE_GROUP_NAME"),
+        help="optional name of the Azure vm cluster resource group. Used to determine azure-node-resource-group-name.",
+    )
+    args.add_argument('--azure-node-resource-group-name',
+        default=os.environ.get("AZURE_NODE_RESORUCE_GROUP_NAME"),
+        help="name of the Azure vm cluster node resource group",
+    )
 
 def add_namespace_options(parser):
     args = parser.add_argument_group('Kubernetes options')
@@ -428,6 +441,12 @@ def main(argv):
     elif args.aws:
         logger.info("Building AWS driver")
         driver = AWSDriver()
+    elif args.azure:
+        logger.info("Building Azure driver")
+        driver = AzureDriver(
+            cluster_rg_name=args.azure_resource_group_name,
+            cluster_node_rg_name=args.azure_node_resource_group_name,
+        )
     else:
         logger.info("No driver - some functionality disabled")
         driver = NoCloudDriver()

diff --git a/powerfulseal/clouddrivers/__init__.py b/powerfulseal/clouddrivers/__init__.py
@@ -16,4 +16,5 @@
 from .driver import AbstractDriver
 from .open_stack_driver import OpenStackDriver
 from .aws_driver import AWSDriver
+from .azure_driver import AzureDriver
 from .no_cloud_driver import NoCloudDriver