civo_cli 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b547957f2d531e61809da88d07b4e67e0822f8b950585a7ca6837b42c038a736
-  data.tar.gz: d42ce8e7b56a75affd123b8d233ae24c502177143b1db08c324e1680031e7690
+  metadata.gz: 81e7ed8f71461ca37d64781e74c4f0af20928710a09786450b1c3d453dc4b15d
+  data.tar.gz: dfda2e2d015a3ba6b03c6b706c96bf294fa72ca21f8ba689695ae9f2db46abf6
 SHA512:
-  metadata.gz: 3e47da3fbcde79faae12e110e0118d57d0a6f927f9e06ba2ba542c8b231b35d03e44ce7f69a09cbbbff7eaf53b17a540c0fb374e588687d0cbe18833a8ad66cf
-  data.tar.gz: a3cb039260a20a553eb971ce0fbc206862e5c866e3c9b272f9700e71149099680843302712506dd9e2a53f6619046779d336e73f28e0dccd20b8eff095d44750
+  metadata.gz: d517214d9db059b213825f810b49a1b4bd156f78b0e98589a2957ece959bb0d403662c436cca6c320a69335a2db3a1df92aaaddd4c46d5587bd0921186ccfc34
+  data.tar.gz: 4668d099d3d6d470eb6dc5451961dfe0a1c80e7aece59a37613df8d3592c2bb29285417e2bcafa908710d54997f7352f1fc2642c3862502458d5934e1534ca5c

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.5.7] - 2019-12-04
+### Changed
+- Set a minimum version of activesupport to fix https://github.com/civo/cli/issues/51 (thanks to Dr Nic Williams for the bug report)
+
 ## [0.5.6] - 2019-11-13
 ### Added
 - Support for not installing default applications using `--remove-applications` during k3s cluster creation

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    civo_cli (0.5.6)
+    civo_cli (0.5.7)
+      activesupport (>= 6.0.0)
       bundler (>= 1.17)
       civo (>= 1.2.9)
       colorize
@@ -32,7 +33,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (0.17.0)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     flexirest (1.8.6)
@@ -116,7 +117,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.2.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -7,7 +7,8 @@ Civo CLI is a tool to manage your [Civo.com](https://www.civo.com) account from
 
 ## Table of contents
 - [Introduction](#introduction)
-- [Set-Up](#set-up) 
+- [Set-Up](#set-up)
+- [Docker Usage](#docker-usage)
 - [API Keys](#api-keys)
 - [Instances](#instances)
 - [Kubernetes clusters](#kubernetes-clusters)
@@ -46,13 +47,34 @@ To run the tool, simply run `civo` with your chosen options. You can find contex
 `civo instance help create`
 and so on. The main components of Civo CLI are outlined in the following sections.
 
+## Docker Usage
+Civo's CLI utilty can also run within a Docker container, which avoids the need to maintain a Ruby environment on the main system.
+
+To run, you generally will want to map the API key for presistence.
+
+```
+touch $HOME/.civo.json
+docker run -it --rm -v $HOME/.civo.json:/home/user/.civo.json civo/cli:latest
+```
+
+To make usage easier, an alias is recommended.  Here's an example how to set one to the same command as would be used if installed directly on the system, and using the Docker image:
+
+```
+alias civo="docker run -it --rm -v $HOME/.civo.json:/home/user/.civo.json civo/cli:latest"
+# Maybe put the above line in ~/.bash_profile or ~/.zshrc
+civo sshkey list
+civo instance list
+civo instance create --size g2.xsmall
+civo k8s list
+```
+
 ## API Keys
 #### Introduction
-In order to use the command-line tool, you will need to authenticate yourself to the Civo API using a special key. You can find an automatically-generated API key or regenerate a new key at [https://www.civo.com/api](https://www.civo.com/api). 
+In order to use the command-line tool, you will need to authenticate yourself to the Civo API using a special key. You can find an automatically-generated API key or regenerate a new key at [https://www.civo.com/api](https://www.civo.com/api).
 
 #### Adding a current API Key to your account
 You can add the API Key to the CLI tool through the API Keys command.
-`civo apikey add apikey_name apikey` such as: 
+`civo apikey add apikey_name apikey` such as:
 
 ```
 $ civo apikey add Demo_Test_Key DAb75oyqVeaE7BI6Aa74FaRSP0E2tMZXkDWLC9wNQdcpGfH51r
@@ -63,7 +85,7 @@ As you can have multiple API keys stored to handle multiple accounts, you will n
 $ civo apikey current Demo_Test_Key
   The current API Key is now Demo_Test_Key
 ```
-#### Managing and listing API keys 
+#### Managing and listing API keys
 You can list all stored API keys in your configuration by invoking `civo apikey list` or remove one by name by using `civo apikey remove apikey_name`.
 
 ## Instances
@@ -107,7 +129,7 @@ $ civo instance show api-demo.test
 
 ----------------------------- NOTES -----------------------------
 
- 
+
 ```
 
 You will be able to see the instance's details by running `civo instance show api-demo.test` as above.
@@ -234,7 +256,7 @@ Provided you have room in your Civo quota, you can upgrade any instance up in si
 ```
 $ civo instance upgrade api-demo-renamed.test g2.medium
  Resizing api-demo-renamed.test to g2.medium. Use 'civo instance show api-demo-renamed.test' to see the current status.
-        
+
 $ civo instance show api-demo-renamed.test
                 ID : 715f95d1-3cee-4a3c-8759-f9b49eec34c4
           Hostname : api-demo-renamed.test
@@ -279,6 +301,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).
+* `version` - the `k3s` version to use on the cluster. Defaults to the latest.
 * `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.
 
@@ -314,6 +337,13 @@ civo kubernetes rename my-first-cluster --name="Production"
 Kubernetes cluster my-first-cluster is now named Production
 ```
 
+#### Starting a cluster without default applications
+By default, `traefik` is bundled in with `k3s` to act as the ingress controller. If you want to set up a cluster without `traefik`, you can use the `remove-applications` option in the creation command to start a cluster without it:
+
+```
+civo kubernetes create --remove-applications=traefik --nodes=2 --wait --save
+```
+
 #### Removing the cluster
 If you're completely finished with a cluster you can delete it with:
 
@@ -447,7 +477,7 @@ $ civo domainrecord create civoclidemo.xyz mx 10.0.0.1 -p=10 -t=1000
 
 #<Civo::DnsRecord id: "2079e6e1-0633-4cd0-b883-e82a8991a91a", created_at: "2019-06-17 12:38:02", updated_at: "2019-06-17 12:38:02", account_id: nil, domain_id: "418181b2-fcd2-46a2-ba7f-c843c331e79b", name: "@", value: "10.0.0.1", type: "mx", priority: 10, ttl: 1000, ETag: "187cf7e849ce53336a889b2bde7ed061", Status: 200>
 Created MX record civoclidemo.xyz for civoclidemo.xyz with a TTL of 1000 seconds and with a priority of 10 with ID 2079e6e1-0633-4cd0-b883-e82a8991a91a
-``` 
+```
 #### Listing DNS Records
 You can get an overview of all records you have created for a particular domain by requesting `civo domainrecord list domain.name`:
 ```
@@ -482,7 +512,7 @@ You will then be able to **configure rules** that allow connections to and from
 * `start_port` - The starting port that the rule applies to. Required.
 * `end_port` - The end of the port range that the rule applies to. Optional; if not specified, the rule will only apply to `start_port` specified.
 * `protocol` - The protocol for the rule (`TCP, UDP, ICMP`). If not provided, defaults to `TCP`.
-* `cidr` - The IP address of the other end (i.e. not your instance) to affect, or a valid network CIDR. Defaults to being globally applied, i.e. `0.0.0.0/0`. 
+* `cidr` - The IP address of the other end (i.e. not your instance) to affect, or a valid network CIDR. Defaults to being globally applied, i.e. `0.0.0.0/0`.
 * `direction` -  Will this rule affect `inbound` or `outbound` traffic? Defaults to `inbound`.
 * `label` - A label for your own reference for this rule. Optional.
 
@@ -521,7 +551,7 @@ You can remove a firewall rule simply by calling `civo firewall delete_rule fire
 ```
 $ civo firewall delete_rule 09f8d85b-0cf1-4dcf-a472-ba247fb4be21 4070f87b-e6c6-4208-91c5-fc4bc72c1587
         Removed Firewall rule 4070f87b-e6c6-4208-91c5-fc4bc72c1587
-        
+
 $ civo firewall list_rules 09f8d85b-0cf1-4dcf-a472-ba247fb4be21
 +-------+----------+------------+----------+------+-------+
 | Firewall rules for 09f8d85b-0cf1-4dcf-a472-ba247fb4be21 |
@@ -565,7 +595,7 @@ Removed the network cli-demo with ID 74b69006-ea59-46a0-96c4-63f5bfa290e1
 
 ## Load Balancers
 #### Introduction
-Civo supports load balancing for your instances, allowing you to spread web traffic between them to maximise availability. You can view details about load balancers you may have running, create new oness, update information and even remove them from the command line. 
+Civo supports load balancing for your instances, allowing you to spread web traffic between them to maximise availability. You can view details about load balancers you may have running, create new oness, update information and even remove them from the command line.
 
 #### Viewing Load Balancers
 You can list currently-active load balancers by calling `civo loadbalancer list`. This will draw a table detailing the unique ID, hostname, protocol, port, TLS certificate information, backend check path and connection information.
@@ -742,7 +772,7 @@ Detailed information about a template can be obtained via the CLI using `civo te
 #### Creating a Template
 You can convert a **bootable** Volume (virtual disk) of an instance, or alternatively use an existing image ID, to create a template. The options for the `civo template create` command are:
 ```
-Options: 
+Options:
   -c, [--cloud-init-file=CLOUD_INIT_FILENAME] # The filename of a file to be used as user-data/cloud-init
   -d, [--description=DESCRIPTION] # A full/long multiline description (optional)
   -i, [--image-id=IMAGE_ID] # The glance ID of the base filesystem image

data/civo_cli.gemspec

@@ -51,4 +51,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "bundler", ">= 1.17"
   spec.add_runtime_dependency 'civo', ">= 1.2.9"
   spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'activesupport', ">= 6.0.0"
 end

data/docker/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:alpine
+MAINTAINER Steve Miller <me@r15cookie.com>
+RUN gem install civo_cli
+RUN adduser -S user
+USER user

data/docker/README.md

@@ -0,0 +1,21 @@
+# Civo CLI in Docker
+
+Build a Docker container embedded with the latest `civo` command.  Note that it does NOT yet build from source;
+it simply pulls the latest Civo CLI from RubyGems.  Usage is in the main repo's README.  The Docker that builds
+from source is a work in progress and available at https://github.com/ssmiller25/cli/tree/dockerbuild
+
+## Pushing to Civo's official DockerHub
+
+For Civo staff only: from the cloned repository, build it with the current version and "latest" tags:
+
+```
+docker build -t civo/cli:latest -f docker/Dockerfile .
+docker build -t civo/cli:0.x.y -f docker/Dockerfile .
+```
+
+Then after running `docker login` to authenticate to the Civo organisation you can do:
+
+```
+docker push civo/cli:latest
+docker push civo/cli:0.x.y
+```

data/lib/apikey.rb

@@ -21,14 +21,16 @@ module CivoCLI
     def add(name, key)
       CivoCLI::Config.set_apikey(name, key)
       puts "Saved the API Key #{key.colorize(:green)} as #{name.colorize(:green)}"
+      current(name)
     end
 
     desc "remove NAME", "Remove the API Key with a label of 'NAME'"
     def remove(name)
-       keys = CivoCLI::Config.get_apikeys
+      keys = CivoCLI::Config.get_apikeys
         if keys.keys.include?(name)
           CivoCLI::Config.delete_apikey(name)
           puts "Removed the API Key #{name.colorize(:green)}"
+          current(nil)
         else
           puts "The API Key #{name.colorize(:red)} couldn't be found."
           exit 1
@@ -37,9 +39,12 @@ module CivoCLI
     map "delete" => "remove", "rm" => "remove"
 
     desc "current [NAME]", "Either return the name of the current API key or set the current key to be the one with a label of 'NAME'"
-    def current(name=nil)
-      if name.nil?
-        puts "The current API Key is #{CivoCLI::Config.get_current_apikey_name.colorize(:green)}"
+    def current(name = nil)
+      currentkey = CivoCLI::Config.get_current_apikey_name
+      if name.nil? && currentkey
+          puts "The current API Key is #{currentkey.colorize(:green)}"
+      elsif name.nil? && !currentkey
+          puts "No current API Key set".colorize(:red)
       else
         keys = CivoCLI::Config.get_apikeys
         if keys.keys.include?(name)

data/lib/civo_cli/version.rb

@@ -1,3 +1,3 @@
 module CivoCLI
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civo_cli
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Andy Jeffries
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -180,6 +180,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: The official command line client for interacting with Civo's API
 email:
 - andy@civo.com
@@ -203,6 +217,8 @@ files:
 - bin/console
 - bin/setup
 - civo_cli.gemspec
+- docker/Dockerfile
+- docker/README.md
 - exe/civo
 - lib/apikey.rb
 - lib/ask_service.rb