civo_cli 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc18131d19cedfa2820c3e95fe1d4ac11ef445fc7ff7d135e66c36b44a99642d
-  data.tar.gz: d5f5db7e0f7b09be339f35cbfa455be3e6cd0cc87cced3879aefb74847c3f2b2
+  metadata.gz: 7490809da82e850e68b3f4bb27241b8f87048ab372a5a5d5a59f8f7000e7d672
+  data.tar.gz: 5e5f15459e0bbdcb994274bb5d8b69bbb91d03d754d681131c20029fccd183b1
 SHA512:
-  metadata.gz: 79a321b15fc1ad58970324a440621f9ff035cfeec8429a152bc79a6fee82554423d2b6b523b118908ea43b3e74c4511fcad682768c0500f1be9169b8c33c3e26
-  data.tar.gz: d08124c5e75a90fc7c0401e62968f6da4683b4522134dcf50296ac7510b585bd25630eb8951a299dfc066fb56bace00dacdb29bc1d09650d14f3307c45a12b47
+  metadata.gz: e612c8f5dd8db26e1a7a6032bc49caddb908432871427d7f21c87376b7cd35b01f4655c9f3bdb1f9dc9a21aece3e9dc233f2b2a211f743b88884064585f98c58
+  data.tar.gz: 1846b570f31e6fc4e66195eb6ee45a7852e7b00311c481653882567aebcf3ef368bce4d9a28937e981f6419d172e5e41580e346167b740b17a4ced8d21864df9

data/CHANGELOG.md

@@ -3,6 +3,10 @@ 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.2.4] - 2019-06-28
+### Added
+- Added Kubernetes endpoints for when the service launches
+
 ## [0.2.3] - 2019-06-21
 ### Added
 - Instance name generator

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    civo_cli (0.2.3)
-      civo (>= 1.1.14)
+    civo_cli (0.2.4)
+      civo (>= 1.2.1)
       colorize
       json
       terminal-table
@@ -18,7 +18,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
-    civo (1.1.17)
+    civo (1.2.1)
       commander
       flexirest (>= 1.4.6)
       toml

data/README.md

@@ -8,6 +8,7 @@ Civo CLI is a tool to manage your [Civo.com](https://www.civo.com) account from
 - [Set-Up](#set-up) 
 - [API Keys](#api-keys)
 - [Instances](#instances)
+- [Kubernetes clusters](#kubernetes-clusters)
 - [Domains and Domain Records](#domains-and-domain-records)
 - [Firewalls](#firewalls)
 - [Networks](#networks)
@@ -75,6 +76,7 @@ You can create an instance by running `civo instance create` with a hostname par
 * `initial_user` - The name of the initial user created on the server. If not provided, will default to the template's `default_username` and fallback to `civo`.
 * `ssh_key_id` - The ID of an already  [uploaded SSH public key](#ssh-keys)  to use for login to the default user. Optional; if one isn't provided a random password will be set and returned in the  `initial_password`  field.
 * `tags` - A space-separated list of tags in `'quotation marks'` to be used freely as required. Optional.
+* `wait` - a simple flag (e.g. `--wait`) that will cause the CLI to spin and wait for the instance to be `ACTIVE`.
 
 Example usage:
 ```
@@ -233,6 +235,59 @@ Hello, world!
 ```
 Please note that resizing can take a few minutes.
 
+## Kubernetes clusters
+#### Introduction
+*IMPORTANT:* Kubernetes is in closed-access only at the moment, during testing. The endpoints here will be rejected unless you are one of the closed set of users that can launch them.
+
+#### List clusters
+To see your created domains, simply call `civo kubernetes list`:
+
+```
+$ civo kubernetes list
++--------------------------------------+------+---------+-----------+--------+
+| ID                                   | Name | # Nodes | Size      | Status |
++--------------------------------------+------+---------+-----------+--------+
+| f13e3f64-d657-40dd-8449-c42c6e341208 | test | 3       | g2.medium | ACTIVE |
++--------------------------------------+------+---------+-----------+--------+
+```
+
+####  Create a cluster
+You can create an instance by running `civo kubernetes create` with a cluster name parameter, as well as any options you provide:
+
+* `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`.
+
+```
+$ civo kubernetes create my-first-cluster
+Created Kubernetes cluster my-first-cluster
+```
+
+#### Scaling the cluster
+You can change the total number of nodes in the cluster (obviously 1 is the minimum) live while the cluster is running. It takes the name of the cluster (or the ID) and a parameter of `--nodes` which is the new number of nodes to run
+
+```
+civo kubernetes scale my-first-cluster --nodes=4
+Kubernetes cluster my-first-cluster will now have 4 nodes
+```
+
+#### 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:
+
+```
+civo kubernetes rename my-first-cluster --name="Production"
+Kubernetes cluster my-first-cluster is now named Production
+```
+
+#### Removing the cluster
+If you're completely finished with a cluster you can delete it with:
+
+```
+civo kubernetes remove my-first-cluster
+Removing Kubernetes cluster my-first-cluster
+```
+
+
 ## Domains and Domain Records
 #### Introduction
 We host reverse DNS for all instances automatically. If you'd like to manage forward (normal) DNS for your domains, you can do that for free within your account.
@@ -250,7 +305,7 @@ Created a domain called civoclidemo.xyz with ID 418181b2-fcd2-46a2-ba7f-c843c331
 ```
 You can then proceed to add DNS records to this domain.
 
-#### List Domain Namess
+#### List Domain Names
 To see your created domains, simply call `civo domain list`:
 ```
 $ civo domain list
@@ -635,4 +690,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/civo/c
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/civo_cli.gemspec

@@ -49,6 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'terminal-table'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'colorize'
-  spec.add_runtime_dependency 'civo', ">= 1.1.14"
+  spec.add_runtime_dependency 'civo', ">= 1.2.1"
   spec.add_runtime_dependency 'json'
 end

data/lib/apikey.rb

@@ -28,12 +28,10 @@ module CivoCLI
         if keys.keys.include?(name)
           CivoCLI::Config.delete_apikey(name)
           puts "Removed the API Key #{name.colorize(:green)}"
-        else 
+        else
           puts "The API Key #{name.colorize(:red)} couldn't be found."
           exit 1
         end
-
-
     end
     map "delete" => "remove", "rm" => "remove"
 
@@ -52,6 +50,7 @@ module CivoCLI
         end
       end
     end
+    map "use" => "current"
 
     default_task :list
   end

data/lib/civo_cli.rb

@@ -35,6 +35,10 @@ module CivoCLI
     subcommand "instance", CivoCLI::Instance
     map "instances" => "instance"
 
+    desc "kubernetes", "manage kubernetess"
+    subcommand "kubernetes", CivoCLI::Kubernetes
+    map "k8s" => "kubernetes"
+
     desc "network", "manage networks"
     subcommand "network", CivoCLI::Network
     map "networks" => "network"

data/lib/civo_cli/version.rb

@@ -1,3 +1,3 @@
 module CivoCLI
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/instance.rb

@@ -89,6 +89,7 @@ module CivoCLI
     option :snapshot, banner: 'snapshot_id'
     option :ssh_key, banner: 'ssh_key_id'
     option :tags, banner: "'tag1 tag2 tag3...'"
+    option :wait, type: :boolean
     long_desc <<-LONGDESC
       Create a new instance with hostname (randomly assigned if blank), instance size (default: g2.small),
       \x5template or snapshot ID (default: Ubuntu 18.04 template).
@@ -101,23 +102,37 @@ module CivoCLI
       \x5 --ssh_key=<ssh_key_id> - for specifying a SSH login key for the default user. Random password assigned if blank, visible by calling `civo instance show hostname`
       \x5 --region=<regioncode> from available Civo regions. Randomly assigned if blank
       \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)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances", requires: [:hostname, :size, :region],
-      # defaults: {public_ip: true, initial_user: "civo"}
       CivoCLI::Config.set_api_auth
       if options[:template] && options[:snapshot] || !options[:template] && !options[:snapshot]
         puts "Please provide either template OR snapshot ID".colorize(:red)
         exit 1
       end
+
       if options[:template]
-        Civo::Instance.create(hostname: hostname, size: options[:size], template: options[:template], initial_user: options[:initial_user], region: options[:region], ssh_key_id: options[:ssh_key], tags: options[:tags])
+        @instance = Civo::Instance.create(hostname: hostname, size: options[:size], template: options[:template], initial_user: options[:initial_user], region: options[:region], ssh_key_id: options[:ssh_key], tags: options[:tags])
+      elsif options[:snapshot]
+        @instance = Civo::Instance.create(hostname: hostname, size: options[:size], snapshot_id: options[:snapshot], initial_user: options[:initial_user], region: options[:region], ssh_key_id: options[:ssh_key], tags: options[:tags])
       end
 
-      if options[:snapshot]
-        Civo::Instance.create(hostname: hostname, size: options[:size], snapshot_id: options[:snapshot], initial_user: options[:initial_user], region: options[:region], ssh_key_id: options[:ssh_key], tags: options[:tags])
+      if options[:wait]
+        print "Building new instance #{hostname}: "
+
+        spinner = CivoCLI::Spinner.spin(instance: @instance) do |s|
+          Civo::Instance.all.items.each do |instance|
+            if instance.id == @instance.id && instance.status == 'ACTIVE'
+              s[:final_instance] = instance
+            end
+          end
+          s[:final_instance]
+        end
+
+        puts "\b Done\nCreated instance #{spinner[:final_instance].hostname.colorize(:green)} - #{spinner[:final_instance].initial_user}@#{spinner[:final_instance].public_ip}"
+      else
+        puts "Created instance #{hostname.colorize(:green)}"
       end
-      puts "Created instance #{hostname.colorize(:green)}"
     rescue Flexirest::HTTPException => e
       puts e.result.reason.colorize(:red)
       exit 1
@@ -171,6 +186,7 @@ module CivoCLI
       puts e.result.reason.colorize(:red)
       exit 1
     end
+    map "delete" => "remove"
 
     desc "reboot ID/HOSTNAME", "reboots instance with ID/hostname entered"
     def reboot(id)

data/lib/kubernetes.rb

@@ -0,0 +1,172 @@
+module CivoCLI
+  class Kubernetes < Thor
+    desc "list", "list all kubernetes clusters"
+    def list
+      CivoCLI::Config.set_api_auth
+      rows = []
+      Civo::Kubernetes.all.items.each do |cluster|
+        rows << [cluster.id, cluster.name, cluster.num_target_nodes, cluster.target_nodes_size, cluster.status]
+      end
+      puts Terminal::Table.new headings: ['ID', 'Name', '# Nodes', 'Size', 'Status'], rows: rows
+    rescue Flexirest::HTTPForbiddenClientException
+      reject_user_access
+    end
+
+    desc "show ID/NAME", "show a Kubernetes cluster by ID or name"
+    def show(id)
+      CivoCLI::Config.set_api_auth
+      rows = []
+      cluster = detect_cluster_id(id)
+
+      puts "                ID : #{cluster.id}"
+      puts "              Name : #{cluster.name}"
+      puts "           # Nodes : #{cluster.num_target_nodes}"
+      puts "              Size : #{cluster.target_nodes_size}"
+      case cluster.status
+      when "ACTIVE"
+        puts "            Status : #{cluster.status.colorize(:green)}"
+      when /ING$/
+        puts "            Status : #{cluster.status.colorize(:orange)}"
+      else
+        puts "            Status : #{cluster.status.colorize(:red)}"
+      end
+      puts "           Version : #{cluster.kubernetes_version}"
+      puts "      API Endpoint : #{cluster.kubeconfig[/https:\/\/(\d+.)*:6443/]}"
+      #<Civo::Kubernetes id: "9f1cf43c-a924-468f-baa7-38dbe0e98ff0", name: "chris-edward", version: "1", status: "ACTIVE", num_target_nodes: 3, target_nodes_size: "g2.medium", built_at: "2019-06-27 16:56:25", kubeconfig: "apiVersion: v1\nclusters:\n- cluster:\n    certificate...", kubernetes_version: "0.6.1", created_at: "2019-06-27 16:52:10", instances: #<Flexirest::ResultIterator:0x00007fc43847d958 @_status=nil, @_headers=nil, @items=[#<Civo::Kubernetes hostname: "k8s-node-acf8", size: "g2.medium", region: "lon1", created_at: "2019-06-27 16:52:11", status: "ACTIVE", firewall_id: "fdf99ced-e257-4ddf-9c81-da81a1dea4ff", public_ip: "185.136.234.35">, #<Civo::Kubernetes hostname: "k8s-node-3615", size: "g2.medium", region: "lon1", created_at: "2019-06-27 16:52:11", status: "ACTIVE", firewall_id: "fdf99ced-e257-4ddf-9c81-da81a1dea4ff", public_ip: "185.136.232.85">, #<Civo::Kubernetes hostname: "k8s-master-4f46", size: "g2.medium", region: "lon1", created_at: "2019-06-27 16:52:11", status: "ACTIVE", firewall_id: "fdf99ced-e257-4ddf-9c81-da81a1dea4ff", public_ip: "185.136.232.240">]>>
+
+      puts ""
+      rows = []
+      cluster.instances.each do |instance|
+        rows << [instance.hostname, instance.public_ip, instance.status]
+      end
+      puts Terminal::Table.new headings: ['Name', 'IP', 'Status'], rows: rows
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+
+    desc "config ID/NAME", "get the ~/.kube/config for a Kubernetes cluster by ID or name"
+    def config(id)
+      CivoCLI::Config.set_api_auth
+      rows = []
+      cluster = detect_cluster_id(id)
+      puts cluster.kubeconfig
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+
+    desc "create [NAME] [...]", "create a new kubernetes cluster with the specified name and provided options"
+    option :size, default: 'g2.medium', banner: 'size'
+    option :nodes, default: '3', banner: 'node_count'
+    option :wait, 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.
+    LONGDESC
+    def create(name = CivoCLI::NameGenerator.create, *args)
+      CivoCLI::Config.set_api_auth
+      @cluster = Civo::Kubernetes.create(name: name, target_nodes_size: options[:size], num_target_nodes: options[:nodes])
+
+      if options[:wait]
+        print "Building new Kubernetes cluster #{name.colorize(:green)}: "
+
+        spinner = CivoCLI::Spinner.spin(instance: @instance) do |s|
+          Civo::Kubernetes.all.items.each do |cluster|
+            if cluster.id == @cluster.id && cluster.status == 'ACTIVE'
+              s[:final_cluster] = cluster
+            end
+          end
+          s[:final_cluster]
+        end
+
+        puts "\b Done\nCreated Kubernetes cluster #{spinner[:final_cluster].name.colorize(:green)}"
+      else
+        puts "Created Kubernetes cluster #{name.colorize(:green)}"
+      end
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+
+    desc "rename ID/NAME [--name]", "rename Kubernetes cluster"
+    option :name
+    long_desc <<-LONGDESC
+      Use --name=new_host_name to specify the new name you wish to use.
+    LONGDESC
+    def rename(id)
+      CivoCLI::Config.set_api_auth
+      cluster = detect_cluster_id(id)
+
+      if options[:name]
+        Civo::Kubernetes.update(id: cluster.id, name: options[:name])
+        puts "Kubernetes cluster #{cluster.id} is now named #{options[:name].colorize(:green)}"
+      end
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+
+    desc "scale ID/NAME [--nodes]", "rescale the Kubernetes cluster to a new node count"
+    option :nodes
+    long_desc <<-LONGDESC
+      Use --nodes=count to specify the new number of nodes to run.
+    LONGDESC
+    def scale(id)
+      CivoCLI::Config.set_api_auth
+      cluster = detect_cluster_id(id)
+
+      if options[:nodes]
+        Civo::Kubernetes.update(id: cluster.id, num_target_nodes: options[:nodes])
+        puts "Kubernetes cluster #{cluster.name.colorize(:green)} will now have #{options[:nodes].colorize(:green)} nodes"
+      end
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+    map "rescale" => "scale"
+
+    desc "remove ID/NAME", "removes an entire Kubernetes cluster with ID/name entered (use with caution!)"
+    def remove(id)
+      CivoCLI::Config.set_api_auth
+      cluster = detect_cluster_id(id)
+
+      puts "Removing Kubernetes cluster #{cluster.name.colorize(:red)}"
+      cluster.remove
+    rescue Flexirest::HTTPException => e
+      puts e.result.reason.colorize(:red)
+      exit 1
+    end
+    map "delete" => "remove", "destroy" => "remove"
+
+    default_task :list
+
+    private
+
+    def detect_cluster_id(id)
+      result = []
+      Civo::Kubernetes.all.items.each do |cluster|
+        result << cluster
+      end
+      result.select! { |cluster| cluster.name.include?(id) }
+
+      if result.count.zero?
+        puts "No Kubernetes clusters found for '#{id}'. Please check your query."
+        exit 1
+      elsif result.count > 1
+        puts "Multiple possible Kubernetes clusters found for '#{id}'. Please try with a more specific query."
+        exit 1
+      else
+        result[0]
+      end
+    end
+
+    def reject_user_access
+      puts "Sorry, this functionality is currently in closed beta and not available to the public yet"
+      exit(1)
+    end
+  end
+end

data/lib/namegenerator.rb

@@ -7,4 +7,4 @@ module CivoCLI
     WORDS.sample(count).join("-")
   end
 end
-end
+end

data/lib/spinner.rb

@@ -0,0 +1,61 @@
+module CivoCLI
+  print "\033[?25l"
+  class Spinner
+    SPINNER_SHAPES = ['|', '/', '-', '\\'].freeze
+    DELAY = 0.1
+
+    attr_accessor :data
+
+    def self.spin(data = {}, &block)
+      new(data, &block).spin
+    end
+
+    def initialize(data = {}, &block)
+      @data = data
+      @spinner_frame = 0
+      @counter = 20
+      @total = 3600 / DELAY
+      @block = block
+      spin
+    end
+
+    def method_missing(name)
+      @data[name] if @data.keys.include?(name)
+    end
+
+    def [](key)
+      @data[key] if @data.keys.include?(key)
+    end
+
+    def []=(key, value)
+      @data[key] = value
+    end
+
+    def spin
+      print "\033[?25l"
+      while(@total > 0) do
+        sleep(DELAY)
+        print SPINNER_SHAPES[@spinner_frame] + "\b"
+        @spinner_frame += 1
+        @spinner_frame = 0 if @spinner_frame == SPINNER_SHAPES.length
+        @counter -= 1
+        @total -= 1
+        next unless @counter == 0
+
+        @counter = 20
+        if result = @block.call(self)
+          self.data[:result] = result
+          print "\033[?25h"
+          return self
+        end
+      end
+
+      print "\033[?25h"
+    rescue Interrupt
+      print "\b\b" + "Exiting.\n"
+      exit 1
+    ensure
+      print "\033[?25h"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civo_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andy Jeffries
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,14 +158,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.14
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.14
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -213,12 +213,14 @@ files:
 - lib/domain_record.rb
 - lib/firewall.rb
 - lib/instance.rb
+- lib/kubernetes.rb
 - lib/namegenerator.rb
 - lib/network.rb
 - lib/quota.rb
 - lib/region.rb
 - lib/size.rb
 - lib/snapshot.rb
+- lib/spinner.rb
 - lib/sshkey.rb
 - lib/sub_command_base.rb
 - lib/template.rb