civo_cli 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ccd3f61d8a3693962d4dd59039aa43c5138745c63be90a6138c07903cc0f50a
-  data.tar.gz: 5408ab15762175cb0720a9ac746d049e23e6f03da589ef5c54c70def21a7ed2e
+  metadata.gz: f677f74099b68315c824843def3112cc20190588066d6efe027abae1f02dd3fb
+  data.tar.gz: fcd21eee2af1e684d2f1f427d8db66d354a2dac7e929baa8686d6e18e09324c1
 SHA512:
-  metadata.gz: bccfa3c0f62c7d404fe883548716dfd36fb012965bd8006c83bff1624ee4fa0229a562d34aaaac343f03cd58b465e77f1dc531028b7ff1c5cb30f1869c2d6b7a
-  data.tar.gz: da98e39e9e6f48176d7212bd3faa8850d9a07092133abbad7416f21876db7358237ee28cc1ab4c3176960e3cca21722e7eeb9269460a3aa72bfd8242a3a52113
+  metadata.gz: 98559a1e50cf114746c8707a61277836e78187bbafa4c319ff1de329d621a663a153fcaf7ef93f4864cb0b3018976d07309dbbe69a75f7bef80ea945bc6a0b94
+  data.tar.gz: f51e7291b27b3a520210fe80ecab4c073e77476408f1b2517a1262a58a01941722a172d112e0f1bfa34df0f559714ae15f5ad848ec5c66023dd24cf53766fe93

data/CHANGELOG.md

@@ -3,6 +3,16 @@ 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.4.7] - 2019-10-17
+### Added
+- Ability to upgrade an existing k3s cluster `civo k3s upgrade`.
+
+## [0.4.6] - 2019-10-08
+### Fixed
+- Behaviour of Kubernetes cluster configuration saving in Windows
+### Added
+- Help text for some common aliases when running `civo help`.
+
 ## [0.4.5] - 2019-09-30
 ### Changed
 - Set default for reboot to be a soft reboot, and made hard-reboot an optional extra command

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    civo_cli (0.4.5)
+    civo_cli (0.4.7)
       bundler (~> 1.17)
-      civo (>= 1.2.8)
+      civo (>= 1.2.9)
       colorize
       json
       terminal-table
@@ -20,7 +20,7 @@ GEM
       zeitwerk (~> 2.1, >= 2.1.8)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
-    civo (1.2.8)
+    civo (1.2.9)
       commander
       flexirest (>= 1.4.6)
       toml
@@ -32,7 +32,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (0.16.2)
+    faraday (0.17.0)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     flexirest (1.8.6)
@@ -57,8 +57,8 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (1.0.0)
-    highline (2.0.2)
-    i18n (1.6.0)
+    highline (2.0.3)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     json (2.2.0)
     listen (3.1.5)
@@ -69,9 +69,9 @@ GEM
     method_source (0.9.2)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
+    mime-types-data (3.2019.1009)
     minitest (5.12.2)
-    multi_json (1.13.1)
+    multi_json (1.14.1)
     multipart-post (2.1.1)
     nenv (0.3.0)
     notiffany (0.1.3)
@@ -116,7 +116,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.1.10)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -11,6 +11,7 @@ Civo CLI is a tool to manage your [Civo.com](https://www.civo.com) account from
 - [API Keys](#api-keys)
 - [Instances](#instances)
 - [Kubernetes clusters](#kubernetes-clusters)
+- [Kubernetes applications](#kubernetes-applications)
 - [Domains and Domain Records](#domains-and-domain-records)
 - [Firewalls](#firewalls)
 - [Networks](#networks)
@@ -273,7 +274,7 @@ $ civo kubernetes list
 +--------------------------------------+------+---------+-----------+--------+
 ```
 
-#### Create a cluster
+#### 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`.
@@ -299,10 +300,12 @@ To output a cluster's configuration information, you can invoke `civo kubernetes
 
 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
+civo kubernetes config -s my-first-cluster
 Saved config to ~/.kube/config
 ```
 
+If you already have a `~/.kube/config` file, any cluster configuration that is saved will be merged to the file, allowing you to switch contexts at will.
+
 #### 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:
 
@@ -319,6 +322,85 @@ civo kubernetes remove my-first-cluster
 Removing Kubernetes cluster my-first-cluster
 ```
 
+## Kubernetes Applications
+#### Introduction
+You can install applications from the [Applications Marketplace](https://github.com/civo/kubernetes-marketplace/) through the command-line interface. The installation depends on if you are creating a new cluster or adding applications to an existing cluster.
+
+#### Listing Available Applications
+To get an up-to-date list of available applications on the Marketplace, run `civo apps list`. At the time of writing, the list looked like this:
+```
++---------------------+------------+--------------+-----------------+--------------+
+| Name                | Version    | Category     | Plans           | Dependencies |
++---------------------+------------+--------------+-----------------+--------------+
+| cert-manager        | v0.10.0    | architecture | Not applicable  | Helm         |
+| Helm                | 2.14.3     | management   | Not applicable  |              |
+| Linkerd             | 2.5.0      | architecture | Not applicable  |              |
+| Longhorn            | 0.5.0      | storage      | Not applicable  |              |
+| Maesh               | Latest     | architecture | Not applicable  | Helm         |
+| MariaDB             | 10.4.7     | database     | 5GB, 10GB, 20GB | Longhorn     |
+| metrics-server      | Latest     | architecture | Not applicable  | Helm         |
+| MinIO               | 2019-08-29 | storage      | 5GB, 10GB, 20GB | Longhorn     |
+| MongoDB             | 4.2.0      | database     | 5GB, 10GB, 20GB | Longhorn     |
+| OpenFaaS            | 0.18.0     | architecture | Not applicable  | Helm         |
+| PostgreSQL          | 11.5       | database     | 5GB, 10GB, 20GB | Longhorn     |
+| prometheus-operator | 0.32.0     | monitoring   | Not applicable  | Helm         |
+| Redis               | 3.2        | database     | Not applicable  |              |
+| Traefik             | (default)  | architecture | Not applicable  |              |
++---------------------+------------+--------------+-----------------+--------------+
+```
+
+
+#### Installing Applications Onto a New Cluster
+To specify applications to install onto a new cluster, list them at cluster creation by specifying their `name` from the list above:
+```
+$ civo kubernetes create apps-demo-cluster --nodes=2 --applications=Redis,Linkerd
+Created Kubernetes cluster apps-demo-cluster.
+```
+Now, if you take a look at the cluster's details, you will see the newly-installed applications listed:
+```
+$ civo kubernetes show apps-demo
+                ID : 1199efbe-e2a5-4d25-a32f-0b7aa50082b2
+              Name : apps-demo-cluster
+           # Nodes : 2
+              Size : g2.medium
+            Status : ACTIVE
+           Version : 0.8.1
+      API Endpoint : https://[Cluster-IP]:6443
+      DNS A record : 1199efbe-e2a5-4d25-a32f-0b7aa50082b2.k8s.civo.com
+
+Nodes:
++------------------+----------------+--------+
+| Name             | IP             | Status |
++------------------+----------------+--------+
+| kube-master-1e91 |      (IP)      | ACTIVE |
+| kube-node-e678   |      (IP)      | ACTIVE |
++------------------+----------------+--------+
+
+Installed marketplace applications:
++---------+-----------+-----------+--------------+
+| Name    | Version   | Installed | Category     |
++---------+-----------+-----------+--------------+
+| Traefik | (default) | Yes       | architecture |
+| Linkerd | 2.5.0     | Yes       | architecture |
+| Redis   | 3.2       | Yes       | database     |
++---------+-----------+-----------+--------------+
+```
+
+#### Installing Applications to an Existing Cluster
+If you want to add a new application to an existing cluster, you can do so by running the `civo applications` command specifying the cluster and the app(s) you wish to add:
+```
+$ civo applications add Longhorn --cluster=apps-demo
+Added Longhorn 0.5.0 to Kubernetes cluster apps-demo-cluster
+```
+
+#### Installing Applications That Require Plans
+Some applications, specifically database apps, require a storage plan that you can specify at installation time from the list of plan options. If you do not provide a plan for an application that requires one, the CLI will notify you and suggest a default size:
+```
+$ civo applications add mariadb --cluster=apps-demo
+You requested to add MariaDB but didn't select a plan. Please choose one... (5GB, 10GB, 20GB) [5GB]: 10GB
+Thank you, next time you could use "MariaDB:10GB" to choose automatically
+Added MariaDB 10.4.7 to Kubernetes cluster apps-demo-cluster
+```
 
 ## Domains and Domain Records
 #### Introduction

data/civo_cli.gemspec

@@ -49,6 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency "bundler", "~> 1.17"
-  spec.add_runtime_dependency 'civo', ">= 1.2.8"
+  spec.add_runtime_dependency 'civo', ">= 1.2.9"
   spec.add_runtime_dependency 'json'
 end

data/lib/civo_cli.rb

@@ -38,11 +38,11 @@ module CivoCLI
     subcommand "instance", CivoCLI::Instance
     map "instances" => "instance"
 
-    desc "kubernetes", "manage Kubernetes"
+    desc "kubernetes", "manage Kubernetes. Aliases: k8s, k3s"
     subcommand "kubernetes", CivoCLI::Kubernetes
     map "k8s" => "kubernetes", "k3s" => "kubernetes"
 
-    desc "applications", "list and add marketplace applications to Kubernetes clusters"
+    desc "applications", "list and add marketplace applications to Kubernetes clusters. Alias: apps, addons, marketplace, k8s-apps, k3s-apps"
     subcommand "applications", CivoCLI::KubernetesApplications
     map "apps" => "applications", "app" => "applications", "application" => "applications",
       "addon" => "applications", "addons" => "applications", "marketplace" => "applications",

data/lib/civo_cli/version.rb

@@ -1,3 +1,3 @@
 module CivoCLI
-  VERSION = "0.4.5"
+  VERSION = "0.4.7"
 end

data/lib/kubernetes.rb

@@ -5,16 +5,27 @@ module CivoCLI
     option :quiet, type: :boolean, aliases: '-q'
     def list
       CivoCLI::Config.set_api_auth
+      latest_version = get_latest_k3s_version
+      upgrade_available = false
+
       if options[:quiet]
         Civo::Kubernetes.all.items.each do |cluster|
         puts cluster.id
         end
       else
+        upgrade_available = true
         rows = []
         Civo::Kubernetes.all.items.each do |cluster|
-          rows << [cluster.id, cluster.name, cluster.num_target_nodes, cluster.target_nodes_size, cluster.status]
+          version = cluster.kubernetes_version
+          if Gem::Version.new(latest_version) > Gem::Version.new(version)
+            version = "#{version} *".colorize(:red)
+          end
+          rows << [cluster.id, cluster.name, cluster.num_target_nodes, cluster.target_nodes_size, version, cluster.status]
+        end
+        puts Terminal::Table.new headings: ['ID', 'Name', '# Nodes', 'Size', 'Version', 'Status'], rows: rows
+        if upgrade_available
+          puts "\n* An upgrade to v#{latest_version} is available, use - civo k3s upgrade ID - to upgrade it".colorize(:red)
         end
-        puts Terminal::Table.new headings: ['ID', 'Name', '# Nodes', 'Size', 'Status'], rows: rows
       end
     rescue Flexirest::HTTPForbiddenClientException
       reject_user_access
@@ -26,6 +37,7 @@ module CivoCLI
       CivoCLI::Config.set_api_auth
       rows = []
       cluster = Finder.detect_cluster(id)
+      upgrade_available = false
 
       puts "                ID : #{cluster.id}"
       puts "              Name : #{cluster.name}"
@@ -39,9 +51,22 @@ module CivoCLI
       else
         puts "            Status : #{cluster.status.colorize(:red)}"
       end
-      puts "           Version : #{cluster.kubernetes_version}"
+
+      latest_version = get_latest_k3s_version
+      if Gem::Version.new(latest_version) > Gem::Version.new(cluster.kubernetes_version)
+        puts "           Version : " + "#{cluster.kubernetes_version} *".colorize(:red)
+        upgrade_available = true
+      else
+        puts "           Version : #{cluster.kubernetes_version}"
+      end
+
       puts "      API Endpoint : #{cluster.api_endpoint}"
       puts "      DNS A record : #{cluster.id}.k8s.civo.com"
+      puts "                     *.#{cluster.id}.k8s.civo.com"
+
+      if upgrade_available
+        puts "\n* An upgrade to v#{latest_version} is available, use - civo k3s upgrade ID - to upgrade it".colorize(:red)
+      end
 
       puts ""
       puts "Nodes:"
@@ -204,6 +229,23 @@ module CivoCLI
       exit 1
     end
 
+    desc "upgrade ID/NAME [--version]", "upgrade Kubernetes cluster's k3s version"
+    option :version
+    long_desc <<-LONGDESC
+      Use --name=version to specify the new version (or leave blank to automatically use latest)
+    LONGDESC
+    def upgrade(id)
+      CivoCLI::Config.set_api_auth
+      cluster = Finder.detect_cluster(id)
+
+      version = get_latest_k3s_version(options[:version])
+      Civo::Kubernetes.update(id: cluster.id, version: version)
+      puts "Kubernetes cluster #{cluster.name.colorize(:green)} is upgrading to #{version.colorize(:green)}"
+    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
@@ -240,19 +282,32 @@ module CivoCLI
 
     private
 
+    def windows?
+      RUBY_PLATFORM =~ /win32/ || RUBY_PLATFORM =~ /mingw/
+    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
-        if options[:switch]
-          result = `KUBECONFIG=#{tempfile.path}:~/.kube/config kubectl config view --flatten`
+        if windows?
+          home = `echo %HOMEPATH%`.chomp
+          if options[:switch]
+            ENV['KUBECONFIG'] = "#{tempfile.path};#{home}\\.kube\\config"
+          else
+            ENV['KUBECONFIG'] = "#{home}\\.kube\\config;#{tempfile.path}"
+          end
+          result = `kubectl config view --flatten`
         else
-          result = `KUBECONFIG=~/.kube/config:#{tempfile.path} kubectl config view --flatten`
+          if options[:switch]
+            result = `KUBECONFIG=#{tempfile.path}:~/.kube/config kubectl config view --flatten`
+          else
+            result = `KUBECONFIG=~/.kube/config:#{tempfile.path} kubectl config view --flatten`
+          end
         end
-        Dir.mkdir("#{ENV['HOME']}/.kube/") unless Dir.exist?("#{ENV["HOME"]}/.kube/")
-        File.write("#{ENV['HOME']}/.kube/config", result)
+        write_file(result)
         if config_file_exists && options[:switch]
           puts "Merged".colorize(:green) + " config into ~/.kube/config and switched context to #{cluster.name}"
         elsif config_file_exists && !options[:switch]
@@ -266,9 +321,28 @@ module CivoCLI
       end
     end
 
+    def write_file(result)
+      Dir.mkdir("#{ENV['HOME']}/.kube/") unless Dir.exist?("#{ENV["HOME"]}/.kube/")
+      File.write("#{ENV['HOME']}/.kube/config", result)
+    end
+
     def reject_user_access
       puts "Sorry, this functionality is currently in closed beta and not available to the public yet"
       exit(1)
     end
+
+    def get_latest_k3s_version(version = nil)
+      available_versions = Civo::Kubernetes.versions
+      if version
+        if available_versions.detect {|v| v.version == version}
+          version
+        else
+          puts "Version #{version.colorize(:red)} is not available for upgrading"
+          exit(1)
+        end
+      else
+        available_versions.first.version
+      end
+    end
   end
 end

data/lib/kubernetes_applications.rb

@@ -57,7 +57,7 @@ module CivoCLI
 
 
     desc "add NAME --cluster=...", "add the marketplace application to a Kubernetes cluster by ID or name"
-    option :cluster, required: true
+    option :cluster
     long_desc <<-LONGDESC
       Use --cluster=name to specify part of the ID or name of the cluster to add the application to
     LONGDESC

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civo_cli
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Andy Jeffries
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,14 +158,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.2.9
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement