civo_cli 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 978698444b706bd68c75dbee0d66e847ae5deec7094e617667964c30971d9f23
-  data.tar.gz: 042c137693dc532f64f27873e36f3f182e7fd7d4a567d481b84b272118c54a7f
+  metadata.gz: 9a44df2a086732861b0ddfb002a821e58ee1f1a727ba1b788b952171df3da150
+  data.tar.gz: 4fe9581ac67a967491600a9e0ec971ffaecdbff3e1650480a2ed6682627bba9d
 SHA512:
-  metadata.gz: 0ee196d1e1587e05fd0b09099151334a6264a65edec7446182d076d2a49119388d838e78bf37cfe4c48b2e1fb5e5a90bb7ec8c391796296e5d1de97f8a94ce6c
-  data.tar.gz: de0018540d48efd6b9c0b37d27fcc83a394b5fb3be095511e449a9fb2a694c3c10478390f486f92fa8742dfe3240071a28e79953b5fa575ad1615b3dfb9aacff
+  metadata.gz: 8ca1c4c564db1f18c5930767636b90164c213cf9e754ab86e877d4dc95166d26f2147c674b51ea8f3e50b572de0dbd7e234a4cc50e0df2621dafc2bf5299acd2
+  data.tar.gz: a3730a64a3bfba67cea1b28ebda090b0dbd7b70a168b938adc26f56a52ea679472af1e214bf615b1e31869ee8ecf6c79218644666c74fe44d6ebe55bad457d43

data/CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to the Civo CLI will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.6] - 2019-07-25
+### Added
+- `kubernetes config --save` option to save a named cluster's configuration file to `~/.kube/config` (requires `kubectl` to be installed)
+- `kubernetes create --wait --save` option to save a new cluster's configuration to `~/.kube/config` (requires `kubectl` to be installed)
+- Aliases for `show` and `list` in methods where they are available.
+
+### Changed
+- Make `help` the default method when base / subcommand is called with no options/arguments.
+
 ## [0.3.5] - 2019-07-11
 ### Removed
 - Removed password from output of `instance show`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    civo_cli (0.3.5)
+    civo_cli (0.3.6)
       bundler (~> 1.17)
       civo (>= 1.2.1)
       colorize

data/README.md

@@ -278,6 +278,7 @@ You can create an instance by running `civo kubernetes create` with a cluster na
 * `size` -  The size of nodes to create, from the current list of sizes  available at [`civo sizes`](#sizes). Defaults to `g2.medium`.
 * `nodes` -  The number of nodes to create (the master also acts as a node).
 * `wait` - a simple flag (e.g. `--wait`) that will cause the CLI to spin and wait for the cluster to be `ACTIVE`.
+* `save` - a flag used in conjunction with `--wait` (i.e. `--wait --save`) to save the configuration to your local `~/.kube/config` file.
 
 ```
 $ civo kubernetes create my-first-cluster
@@ -292,6 +293,15 @@ civo kubernetes scale my-first-cluster --nodes=4
 Kubernetes cluster my-first-cluster will now have 4 nodes
 ```
 
+#### Viewing or Saving the cluster configuration
+To output a cluster's configuration information, you can invoke `civo kubernetes config cluster-name`. This will output the `kubeconfig` file to the screen.
+
+You can save a cluster's configuration to your local `~/.kube/config` file. This requires `kubectl` to be installed. Usage:
+```
+civo kubernetes save my-first-cluster
+Saved config to ~/.kube/config
+```
+
 #### Renaming the cluster
 Although the name isn't used anywhere except for in the list of clusters (e.g. it's not in any way written in to the cluster), if you wish to rename a cluster you can do so with:
 

data/lib/apikey.rb

@@ -15,6 +15,7 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['Name', 'Key', 'Default?'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
 
     desc "add NAME KEY", "Add the API Key 'KEY' using a label of 'NAME'"
     def add(name, key)
@@ -52,6 +53,6 @@ module CivoCLI
     end
     map "use" => "current"
 
-    default_task :list
+    default_task :help
   end
 end

data/lib/blueprint.rb

@@ -15,6 +15,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "ls" => "list", "all" => "list"
 
     desc "show ID", "show the details for a single blueprint"
     option :verbose, type: :boolean, desc: "Show the converted bash script and last run output", aliases: ["-v"]
@@ -49,6 +50,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "get" => "show", "inspect" => "show"
 
     option "content-file", type: :string, desc: "The filename of a file to be used as the Blueprintfile content", aliases: ["-c"], banner: "CONTENT_FILE"
     option "template-id", type: :string, desc: "The ID of the template to update", aliases: ["-t"], banner: "TEMPLATE_ID"
@@ -129,5 +131,6 @@ module CivoCLI
         result[0]
       end
     end
+    default_task :help
   end
 end

data/lib/civo_cli/version.rb

@@ -1,3 +1,3 @@
 module CivoCLI
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/domain.rb

@@ -9,6 +9,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Name'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     desc "create DOMAIN", "create a new domain name called DOMAIN"
     def create(name)
@@ -33,7 +35,7 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
 
   end
 end

data/lib/domain_record.rb

@@ -13,6 +13,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Type', 'Name', 'Value', 'TTL', 'Priority'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     desc "show RECORD_ID", "show full information for record RECORD_ID (or full DNS name)"
     def show(record_id)
@@ -34,6 +36,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "get" => "show", "inspect" => "show"
 
     option :priority, type: :string, desc: "The priority for MX records", aliases: ["-p"], banner: "PRIORITY"
     option :ttl, type: :string, desc: "The Time-To-Live for this record", aliases: ["-t"], banner: "TTL"
@@ -95,7 +98,7 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
 
     private
 

data/lib/firewall.rb

@@ -23,6 +23,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "ls" => "list", "all" => "list"
 
     desc "remove firewall_ID", "Removes a firewall with Firewall ID provided"
     def remove(firewall_ID)
@@ -81,5 +82,6 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+   default_task :help
   end
 end

data/lib/instance.rb

@@ -1,5 +1,11 @@
 module CivoCLI
   class Instance < Thor
+    DEFAULT_SIZE = 'g2.small'
+    DEFAULT_REGION = 'lon1'
+    DEFAULT_INITIAL_USER = 'civo'
+    DEFAULT_PUBLIC_IP = 'true'
+    DEFAULT_TEMPLATE = '811a8dfb-8202-49ad-b1ef-1e6320b20497'
+
     desc "list", "list all instances"
     def list
       CivoCLI::Config.set_api_auth
@@ -11,6 +17,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Hostname', 'Size', 'Region', 'Public IP', 'Status'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     if CivoCLI::Config.get_meta("admin")
       desc "high-cpu", "list high CPU using instances"
@@ -76,12 +84,14 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "get" => "show", "inspect" => "show"
 
     desc "create [HOSTNAME] [...]", "create a new instance with specified hostname and provided options"
-    option :size, default: 'g2.small', banner: 'instance_size_code'
-    option :region, default: 'lon1', banner: 'civo_region'
-    option :public_ip, default: 'true', banner: 'true | false | from [instance_id]'
-    option :initial_user, default: 'civo', banner: 'username', aliases: '--user'
+    option :name, aliases: '--hostname', banner: 'hostname'
+    option :size, default: DEFAULT_SIZE, banner: 'instance_size_code'
+    option :region, default: DEFAULT_REGION, banner: 'civo_region'
+    option :public_ip, default: DEFAULT_PUBLIC_IP, banner: 'true | false | from [instance_id]'
+    option :initial_user, default: DEFAULT_INITIAL_USER, banner: 'username', aliases: '--user'
     option :template, banner: 'template_id'
     option :snapshot, banner: 'snapshot_id'
     option :ssh_key, banner: 'ssh_key_id', aliases: '--ssh'
@@ -101,15 +111,23 @@ module CivoCLI
       \x5 --tags=<'tag1 tag2 tag3...'> - space-separated tag(s)
       \x5 --wait - wait for build to complete and show status. Off by default.
     LONGDESC
-    def create(hostname = CivoCLI::NameGenerator.create, *args)
+    def create(*args)
       CivoCLI::Config.set_api_auth
+
+      if !options[:name] && !args
+        hostname = CivoCLI::NameGenerator.create
+      elsif options[:name]
+        hostname = options[:name]
+      elsif !options[:name] && args
+        hostname = args.join('-')
+      end
       if options[:template] && options[:snapshot]
         puts "Please provide either template OR snapshot ID".colorize(:red)
         exit 1
       end
 
       if !options[:template] && !options[:snapshot]
-        options[:template] = '811a8dfb-8202-49ad-b1ef-1e6320b20497'
+        options[:template] = DEFAULT_TEMPLATE
       end
 
 
@@ -322,7 +340,7 @@ module CivoCLI
       exit 1  
     end
   
-    default_task :list
+    default_task :help
 
     private
 

data/lib/kubernetes.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 module CivoCLI
   class Kubernetes < Thor
     desc "list", "list all kubernetes clusters"
@@ -11,6 +13,8 @@ module CivoCLI
     rescue Flexirest::HTTPForbiddenClientException
       reject_user_access
     end
+    map "ls" => "list", "all" => "list"
+
 
     desc "show ID/NAME", "show a Kubernetes cluster by ID or name"
     def show(id)
@@ -43,13 +47,26 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "get" => "show", "inspect" => "show"
 
-    desc "config ID/NAME", "get the ~/.kube/config for a Kubernetes cluster by ID or name"
+
+    desc "config ID/NAME [--save]", "get or save the ~/.kube/config for a Kubernetes cluster by ID or name"
+    option :save, type: :boolean, aliases: ['--export', '-s']
+    long_desc <<-LONGDESC
+      Gets the configuration information for a Kubernetes cluster by ID or name.
+      \x5Use optional parameter --save [-s or --export] to merge the fetched configuration
+      \x5into your Kubernetes configuration file at ~/.kube/config.
+      \x5Please note that this option requires you to have `kubectl` installed.
+    LONGDESC
     def config(id)
       CivoCLI::Config.set_api_auth
-      rows = []
       cluster = detect_cluster(id)
-      puts cluster.kubeconfig
+
+      if options[:save]
+        save_config(cluster)
+      else
+        puts cluster.kubeconfig
+      end
     rescue Flexirest::HTTPException => e
       puts e.result.reason.colorize(:red)
       exit 1
@@ -59,12 +76,14 @@ module CivoCLI
     option :size, default: 'g2.medium', banner: 'size'
     option :nodes, default: '3', banner: 'node_count'
     option :wait, type: :boolean
+    option :save, type: :boolean
     long_desc <<-LONGDESC
       Create a new Kubernetes cluster with name (randomly assigned if blank), instance size (default: g2.medium),
       \x5\x5Optional parameters are as follows:
       \x5 --size=<instance_size> - 'g2.medium' if blank. List of sizes and codes to use can be found through `civo sizes`
       \x5 --nodes=<count> - '3' if blank
       \x5 --wait - wait for build to complete and show status. Off by default.
+      \x5 --save - save resulting configuration to ~/.kube/config (requires kubectl and the --wait option)
     LONGDESC
     def create(name = CivoCLI::NameGenerator.create, *args)
       CivoCLI::Config.set_api_auth
@@ -83,8 +102,14 @@ module CivoCLI
         end
 
         puts "\b Done\nCreated Kubernetes cluster #{spinner[:final_cluster].name.colorize(:green)}"
+      elsif !options[:wait] && options[:save]
+        puts "Creating Kubernetes cluster #{name.colorize(:green)}. Can only save configuration once cluster is created."
       else
-        puts "Created Kubernetes cluster #{name.colorize(:green)}"
+        puts "Created Kubernetes cluster #{name.colorize(:green)}."
+      end
+
+      if options[:save] && options[:wait]
+        save_config(spinner.final_cluster)
       end
     rescue Flexirest::HTTPException => e
       puts e.result.reason.colorize(:red)
@@ -139,9 +164,9 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
-    map "delete" => "remove", "destroy" => "remove"
+    map "delete" => "remove", "destroy" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
 
     private
 
@@ -163,6 +188,26 @@ module CivoCLI
       end
     end
 
+    def save_config(cluster)
+      config_file_exists = File.exist?("#{ENV["HOME"]}/.kube/config")
+      tempfile = Tempfile.new('import_kubeconfig')
+      begin
+        tempfile.write(cluster.kubeconfig)
+        tempfile.size
+        result = `KUBECONFIG=#{tempfile.path}:~/.kube/config kubectl config view --flatten`
+        Dir.mkdir("#{ENV['HOME']}/.kube/") unless Dir.exist?("#{ENV["HOME"]}/.kube/")
+        File.write("#{ENV['HOME']}/.kube/config", result)
+        if config_file_exists
+          puts "Merged".colorize(:green) + " config into ~/.kube/config"
+        else
+          puts "Saved".colorize(:green) + " config to ~/.kube/config"
+        end
+      ensure
+        tempfile.close
+        tempfile.unlink
+      end
+    end
+
     def reject_user_access
       puts "Sorry, this functionality is currently in closed beta and not available to the public yet"
       exit(1)

data/lib/network.rb

@@ -13,6 +13,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Label', 'CIDR', 'Default?'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     desc "create LABEL", "create a new private network called LABEL"
     def create(label)
@@ -37,7 +39,7 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
 
   end
 end

data/lib/region.rb

@@ -9,6 +9,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['Code'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     default_task :list
   end

data/lib/snapshot.rb

@@ -9,6 +9,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Name', 'State', "Size (GB)", "Cron"], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     option "cron", type: :string, desc: "The timing of when to take/repeat in cron format", aliases: ["-c"], banner: "CRON_TIMING"
     desc "create NAME INSTANCE_ID [-c '0 * * * *']", "create a snapshot called NAME from instance INSTANCE_ID"
@@ -37,7 +39,7 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
 
   end
 end

data/lib/sshkey.rb

@@ -9,6 +9,8 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Name', 'Fingerprint'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
+
 
     desc "upload NAME FILENAME", "upload the SSH public key in FILENAME to a new key called NAME"
     def upload(name, filename)
@@ -33,6 +35,6 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
   end
 end

data/lib/template.rb

@@ -17,7 +17,6 @@ module CivoCLI
           rows << [template.id, template.name]
         end
         puts Terminal::Table.new headings: ['ID', 'Name'], rows: rows
-   
       end
 
     
@@ -25,8 +24,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
-    map "ls" => "list"
-
+    map "ls" => "list", "all" => "list"
 
     desc "show ID", "show the details for a single template"
     def show(id)
@@ -47,6 +45,8 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "get" => "show", "inspect" => "show"
+
 
     option "cloud-init-file", type: :string, desc: "The filename of a file to be used as user-data/cloud-init", aliases: ["-c"], banner: "CLOUD_INIT_FILENAME"
     option :description, type: :string, desc: "A full/long multiline description", aliases: ["-d"], banner: "DESCRIPTION"
@@ -106,6 +106,6 @@ module CivoCLI
     end
     map "delete" => "remove", "rm" => "remove"
 
-    default_task :list
+    default_task :help
   end
 end

data/lib/volume.rb

@@ -10,6 +10,7 @@ module CivoCLI
       end
       puts Terminal::Table.new headings: ['ID', 'Name', 'Mounted', 'Size (GB)'], rows: rows
     end
+    map "ls" => "list", "all" => "list"
 
     desc "create NAME SIZE", "create a volume of SIZE (GB) called NAME"
     def create(name, size)
@@ -83,6 +84,6 @@ module CivoCLI
       exit 1
     end
 
-    default_task :list
+    default_task :help
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civo_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Andy Jeffries
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake