Merge pull request #207 from qlik-oss/ibiqlik/upx

Move build from CircleCi to GitHub Actions; use UPX to compress binaries #88

.circleci/config.yml

@@ -1,43 +0,0 @@
-# Golang CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-go/ for more details
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/golang:stretch
-    working_directory: /go/src/github.com/qlik-oss/sense-installer
-    steps:
-      - checkout
-      - run: make test
-      - run: make build
-  build_release:
-    docker:
-      - image: circleci/golang:stretch
-    working_directory: /go/src/github.com/qlik-oss/sense-installer
-    steps:
-      - checkout
-      - run: make test
-      - run: make xbuild-all
-      - run:
-          name: "Publish Release on GitHub"
-          command: |
-            go get github.com/tcnksm/ghr
-            ghr -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} -delete ${CIRCLE_TAG}  /go/src/github.com/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/bin/${CIRCLE_TAG}/
-workflows:
-  version: 2
-  commit:
-    jobs:
-      - build:
-          filters:
-            tags:
-              ignore: /^v.*/
-  build_release:
-    jobs:
-      - build_release:
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/
-

.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: Build Sense installer
+
+on: [pull_request]
+
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Go 1.13
+      uses: actions/setup-go@v1
+      with:
+        go-version: 1.13
+
+    - uses: actions/checkout@v2
+    - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+    - name: Set GOPATH
+        # temporary fix
+        # see https://github.com/actions/setup-go/issues/14
+      run: |
+        echo "##[set-env name=GOPATH;]$(dirname $GITHUB_WORKSPACE)"
+        echo "##[add-path]$(dirname $GITHUB_WORKSPACE)/bin"
+      shell: bash
+
+    - run: make test
+    - run: make build

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release Sense installer binaries
+
+on: 
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+
+  release:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Go 1.13
+      uses: actions/setup-go@v1
+      with:
+        go-version: 1.13
+
+    - uses: actions/checkout@v2
+    - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* # Needed in makefile for versioning
+    - name: Set GOPATH
+        # temporary fix
+        # see https://github.com/actions/setup-go/issues/14
+      run: |
+        echo "##[set-env name=GOPATH;]$(dirname $GITHUB_WORKSPACE)"
+        echo "##[add-path]$(dirname $GITHUB_WORKSPACE)/bin"
+      shell: bash
+
+    - run: make test
+    - run: make xbuild-all
+
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        files: bin/**/*

Makefile

@@ -57,17 +57,24 @@ endif
 
 xbuild-all: clean generate
 	$(foreach OS, $(SUPPORTED_PLATFORMS), \
-    	$(foreach ARCH, $(SUPPORTED_ARCHES), \
-            	$(MAKE) $(MAKE_OPTS) CLIENT_PLATFORM=$(OS) CLIENT_ARCH=$(ARCH) MIXIN=$(MIXIN) xbuild; \
-    	))
+		$(foreach ARCH, $(SUPPORTED_ARCHES), \
+			$(MAKE) $(MAKE_OPTS) CLIENT_PLATFORM=$(OS) CLIENT_ARCH=$(ARCH) MIXIN=$(MIXIN) xbuild; \
+	))
+
 	$(MAKE) clean
+
 xbuild: $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
+
 $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT):
 	mkdir -p $(dir $@)
 	GOOS=$(CLIENT_PLATFORM) GOARCH=$(CLIENT_ARCH) $(XBUILD) -o $@ ./cmd/$(MIXIN)
-	tar -czvf $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH).tar.gz -C $(BINDIR)/$(VERSION)/ $(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
-	#tar -C $(BINDIR)/$(VERSION)/ -cvf $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH).tar.gz $(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
 
+ifeq ($(CLIENT_PLATFORM),windows)
+	zip $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH).zip $(BINDIR)/$(VERSION)/ $(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
+else
+	tar -czvf $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH).tar.gz -C $(BINDIR)/$(VERSION)/ $(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
+endif
+	upx $(BINDIR)/$(VERSION)/$(MIXIN)-$(CLIENT_PLATFORM)-$(CLIENT_ARCH)$(FILE_EXT)
 
 generate: get-crds packr2
 	go generate ./...
@@ -85,7 +92,7 @@ clean-packr: packr2
 
 get-crds:
 	$(eval TMP := $(shell mktemp -d))
-	git clone git@github.com:qlik-oss/qliksense-operator.git -b ms-3 $(TMP)/operator
+	git clone https://github.com/qlik-oss/qliksense-operator.git -b ms-3 $(TMP)/operator
 	mkdir -p pkg/qliksense/crds/cr
 	mkdir -p pkg/qliksense/crds/crd
 	mkdir -p pkg/qliksense/crds/crd-deploy

README.md

@@ -1,17 +1,9 @@
 # (WIP) Qlik Sense installation and operations CLI
 
-- [Qlik Sense installation and operations CLI](#qlik-sense-installation-and-operations-cli)
-  - [About](#about)
-    - [Future Direction](#future-direction)
-  - [Getting Started](#getting-started)
-    - [Requirements](#requirements)
-    - [Download](#download)
-    - [TL;DR](#TL;DR)
-    - [How qliksense CLI works](#how-qliksense-cli-works)
-      - [Witout Git Repo](#Without-git-repo)
-      - [With Git Repo](#With-a-git-repo)
-    - [Air Gapped](#air-gaped)
-  
+## Documentation
+
+To learn more about Qlik Sense installer go to https://qlik-oss.github.io/sense-installer/
+
 ## About
 
 The Qlik Sense installer CLI (qliksense) provides an imperative interface to many of the configurations that need to be applied against the declarative structure described in [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s). This cli facilitates:
@@ -31,120 +23,3 @@ For each version of a qliksense edge build there should be a corresponding relea
   - backup/restore operations
   - fully support airgap installation of QSEoK
   - restore unwanted deletion of kubernetes resources
-
-## Getting Started
-
-### Requirements
-
-- `kubectl` need to be installed and configured properly so that `kubectl` can connect to the kubernetes cluser. The `qliksense` CLI uses `kubectl` under the hood to perform operations on cluster
-  - (Docker Desktop setup tested for these instructions)
-  
-### Download
-
-- Download the appropriate executable for your platform from the [releases page](https://github.com/qlik-oss/sense-installer/releases) and rename it to `qliksense`. All the examplease down below uses `qliksense`.
-  
-### TL;DR
-
-- To download the version `v0.0.2` from qliksense-k8s [releases](https://github.com/qlik-oss/qliksense-k8s/releases).
-
-```shell
-$qliksense fetch v0.0.2
-```
-
-- To install CRDs for QSEoK and qliksense operator into the kubernetes cluster.
-
-```shell
-$qliksense crds install --all
-```
-
-- To install QSEoK into a namespace in the kubernetes cluster where `kubectl` is pointing to.
-
-```shell
-$qliksense install --acceptEULA="yes"
-```
-
-## How qliksense cli works
-
-At the initialization `qliksense` cli create few files in the director `~/.qliksene` and it contains following files
-
-```console
-.qliksense
-├── config.yaml
-├── contexts
-│   └── qlik-default
-│       └── qlik-default.yaml
-└── ejson
-    └── keys
-```
-
-`qlik-default.yaml` is a default CR has been created with some default values like this
-
-```yaml
-apiVersion: qlik.com/v1
-kind: Qliksense
-metadata:
-  name: qlik-default
-spec:
-  profile: docker-desktop
-  secrets:
-    qliksense:
-    - name: mongoDbUri
-      value: mongodb://qlik-default-mongodb:27017/qliksense?ssl=false
-  rotateKeys: "yes"
-  releaseName: qlik-default
-```
-
-The `qliksense` cli creates a default qliksense context (different from kubectl context) named `qlik-default` which will be the prefix for all kubernetes resources created by the cli under this context latter on. New context and configuration can be created by the cli.
-
-```console
-$ qliksense config -h
-do operations on/around CR
-
-Usage:
-  qliksense config [command]
-
-Available Commands:
-  apply         generate the patchs and apply manifests to k8s
-  list-contexts retrieves the contexts and lists them
-  set           configure a key value pair into the current context
-  set-configs   set configurations into the qliksense context as key-value pairs
-  set-context   Sets the context in which the Kubernetes cluster and resources live in
-  set-secrets   set secrets configurations into the qliksense context as key-value pairs
-  view          view the qliksense operator CR
-
-Flags:
-  -h, --help   help for config
-
-Use "qliksense config [command] --help" for more information about a command.
-```
-
-`qliksense` cli works in two modes
-
-- with a git repo fork/clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s)
-- without git repo
-
-### Without git repo
-
-In this mode `qliksense` CLI download the specified version from [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and put it into folder `~/.qliksense/contexts/<context-name>/qlik-k8s`.
-
-The qliksense cli create a CR for the qliksense operator and all the config operations are peformed to edit the CR. So when `qliksense install` or `qliksense config apply` both generate patches in local file system (i.e `~/.qliksense/contexts/<context-name>/qlik-k8s`) and install those manifests into the cluster and create a custom resoruce (CR) for the `qliksene operator` then the operator make association to the isntalled resoruces  so that when `qliksenes uninstall` is performed the operator can delete all those kubernetes resources related to QSEoK for the current context.
-
-### With a git repo
-
-User has to create fork or clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and push it to their own git server. When user perform `qliksense install` or `qliksene config apply` the qliksense operator do these tasks
-
-- downloads the corresponding version of manifests from the user's git repo.
-- generate kustomize patches
-- install kubernetes resoruces 
-- push those generated patches into a new branch in the provided git repo. so that user user can merge those patches into their master branch. 
-- spinup a cornjob to monitor master branch. If user modifies anything in the master branch those changes will be applied into the cluster. This is a light weight `git-ops` model
-
-This is how repo info is provided into the CR
-
-```console
-qliksense config set git.repository="https://github.com/my-org/qliksense-k8s"
-
-qliksense config set git.accessToken=blablalaala
-```
-
-## Air gaped

docs/concepts.md

@@ -1,6 +1,6 @@
 # How qliksense cli works
 
-At the initialization `qliksense` cli create few files in the director `~/.qliksene` and it contains following files
+At the initialization, `qliksense` cli creates few files in the director `~/.qliksene` and it contains following files:
 
 ```console
 .qliksense
@@ -12,7 +12,7 @@ At the initialization `qliksense` cli create few files in the director `~/.qliks
     └── keys
 ```
 
-`qlik-default.yaml` is a default CR has been created with some default values like this
+`qlik-default.yaml` is a default CR created with some default values like:
 
 ```yaml
 apiVersion: qlik.com/v1
@@ -29,55 +29,49 @@ spec:
   releaseName: qlik-default
 ```
 
-The `qliksense` cli creates a default qliksense context (different from kubectl context) named `qlik-default` which will be the prefix for all kubernetes resources created by the cli under this context latter on. New context and configuration can be created by the cli.
+The `qliksense` cli creates a default qliksense context (different from kubectl context) named `qlik-default` which will be the prefix for all kubernetes resources created by the cli under this context later on. 
+
+New context and configuration can be created by the cli, get available commands using:
 
 ```console
-$ qliksense config -h
-do operations on/around CR
-
-Usage:
-  qliksense config [command]
-
-Available Commands:
-  apply         generate the patchs and apply manifests to k8s
-  list-contexts retrieves the contexts and lists them
-  set           configure a key value pair into the current context
-  set-configs   set configurations into the qliksense context as key-value pairs
-  set-context   Sets the context in which the Kubernetes cluster and resources live in
-  set-secrets   set secrets configurations into the qliksense context as key-value pairs
-  view          view the qliksense operator CR
-
-Flags:
-  -h, --help   help for config
-
-Use "qliksense config [command] --help" for more information about a command.
+qliksense config -h
 ```
 
+---
+
 `qliksense` cli works in two modes
 
-- with a git repo fork/clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s)
-- without git repo
+- With a git repo fork/clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s)
+- Without git repo
 
 ## Without git repo
 
-In this mode `qliksense` CLI download the specified version from [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and put it into folder `~/.qliksense/contexts/<context-name>/qlik-k8s`.
+In this mode `qliksense` CLI downloads the specified version from [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and places it in `~/.qliksense/contexts/<context-name>/qlik-k8s` folder.
 
-The qliksense cli create a CR for the qliksense operator and all the config operations are peformed to edit the CR. So when `qliksense install` or `qliksense config apply` both generate patches in local file system (i.e `~/.qliksense/contexts/<context-name>/qlik-k8s`) and install those manifests into the cluster and create a custom resoruce (CR) for the `qliksene operator` then the operator make association to the isntalled resoruces  so that when `qliksenes uninstall` is performed the operator can delete all those kubernetes resources related to QSEoK for the current context.
+The qliksense cli creates a CR for the QlikSense operator and all config operations are peformed to edit the CR.
+
+`qliksense install` or `qliksense config apply` will generate patches in local file system (i.e `~/.qliksense/contexts/<context-name>/qlik-k8s`) and
+
+- Install those manifests into the cluster 
+- Create a custom resoruce (CR) for the `qliksene operator`.
+
+The operator makes the association to the installed resoruces so that when `qliksense uninstall` is performed the operator can delete all kubernetes resources related to QSEoK for the current context.
 
 ## With a git repo
 
-User has to create fork or clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and push it to their own git server. When user perform `qliksense install` or `qliksene config apply` the qliksense operator do these tasks
+Create a fork or clone of [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) and push it to your git repo/server
 
-- downloads the corresponding version of manifests from the user's git repo.
-- generate kustomize patches
-- install kubernetes resoruces 
-- push those generated patches into a new branch in the provided git repo. so that user user can merge those patches into their master branch. 
-- spinup a cornjob to monitor master branch. If user modifies anything in the master branch those changes will be applied into the cluster. This is a light weight `git-ops` model
+To add your repo into CR, perform the following:
 
-This is how repo info is provided into the CR
-
-```console
+```bash
 qliksense config set git.repository="https://github.com/my-org/qliksense-k8s"
-
-qliksense config set git.accessToken=blablalaala
+qliksense config set git.accessToken="<mySecretToken>"
 ```
+
+When you perform `qliksense install` or `qliksene config apply`, qliksense operator performs these tasks:
+
+- Download corresponding version of manifests from the your git repo
+- Generate kustomize patches
+- Install kubernetes resources
+- Push generated patches into a new branch in the provided git repo. _Gives you ability to merge patches into your master branch_
+- Create a CronJob to monitor master branch. Any changes pushed to master branch will be applied into the cluster. _This is a light weight `git-ops` model_

docs/getting_started.md

@@ -2,29 +2,52 @@
 
 ## Requirements
 
-- `kubectl` need to be installed and configured properly so that `kubectl` can connect to the kubernetes cluser. The `qliksense` CLI uses `kubectl` under the hood to perform operations on cluster
-  - (Docker Desktop setup tested for these instructions)
+- Kubernetes cluster (Docker Desktop with enabled Kubernetes)
+- `kubectl` installed, configured and able to communicate with kubernetes cluster. _`qliksense` CLI uses `kubectl` under the hood to perform operations on cluster_
 
-## Download
+## Installing Sense installer
+
+Download the executable for your platform from [releases page](https://github.com/qlik-oss/sense-installer/releases) and rename it to `qliksense`
+
+??? tldr "Linux"
+
+    ``` bash
+    curl -Lo qliksense https://github.com/qlik-oss/sense-installer/releases/download/v0.7.0/qliksense-linux-amd64
+    chmod +x qliksense
+    sudo mv qliksense /usr/local/bin
+    ```
+
+??? tldr "MacOS"
+
+    ``` bash
+    curl -Lo qliksense https://github.com/qlik-oss/sense-installer/releases/download/v0.7.0/qliksense-darwin-amd64
+    chmod +x qliksense
+    sudo mv qliksense /usr/local/bin
+    ```
+
+??? tldr "Windows"
+    Download Windows executable and add it in your `PATH` as `qliksense.exe`
+
+    [https://github.com/qlik-oss/sense-installer/releases/download/v0.7.0/qliksense-windows-amd64.exe](https://github.com/qlik-oss/sense-installer/releases/download/v0.7.0/qliksense-windows-amd64.exe)
+    
 
-- Download the appropriate executable for your platform from the [releases page](https://github.com/qlik-oss/sense-installer/releases) and rename it to `qliksense`. All the examplease down below uses `qliksense`.
 
 ## Quick start
 
 - To download the version `v0.0.2` from qliksense-k8s [releases](https://github.com/qlik-oss/qliksense-k8s/releases).
 
 ```shell
-$qliksense fetch v0.0.2
+qliksense fetch v0.0.2
 ```
 
 - To install CRDs for QSEoK and qliksense operator into the kubernetes cluster.
 
 ```shell
-$qliksense crds install --all
+qliksense crds install --all
 ```
 
 - To install QSEoK into a namespace in the kubernetes cluster where `kubectl` is pointing to.
 
 ```shell
-$qliksense install --acceptEULA="yes"
-```
+qliksense install --acceptEULA="yes"
+```

docs/index.md

@@ -1,19 +1,22 @@
 # Overview
 
-The Qlik Sense installer CLI (qliksense) provides an imperative interface to many of the configurations that need to be applied against the declarative structure described in [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s). This cli facilitates:
+The Qlik Sense installer CLI (`qliksense`) provides an imperative interface to many of the configurations that need to be applied against the declarative structure described in [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s). This cli facilitates:
 
-- installation of QSEoK
-- installation of qliksense operator to manage QSEoK
-- air gapped installation of QSEoK
+- Installation of QSEoK
+- Installation of qliksense operator to manage QSEoK
+- Air gapped installation of QSEoK
 
-This is a technology preview that uses Qlik modified [kustomize](https://github.com/qlik-oss/kustomize) to kubernetes manifests of the versions of the [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) repository.
+!!! info ""
+    This is a technology preview that uses Qlik modified [kustomize](https://github.com/qlik-oss/kustomize) for kubernetes manifests on [qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s) repository
 
-For each version of a qliksense edge build there should be a corresponding release in [qliksense-k8s] repository under [releases](https://github.com/qlik-oss/qliksense-k8s/releases)
+!!! info ""
+    See QlikSense [edge releases on qliksense-k8s](https://github.com/qlik-oss/qliksense-k8s/releases) repository
 
 ## Future Direction
 
-- More operations:
-  - Expand preflight checks
-  - backup/restore operations
-  - fully support airgap installation of QSEoK
-  - restore unwanted deletion of kubernetes resources
+Operations:
+
+- Expand preflight checks
+- Backup/restore operations
+- Fully support airgap installation of QSEoK
+- Restore unwanted deletion of kubernetes resources

mkdocs.yml

@@ -10,6 +10,10 @@ markdown_extensions:
   - toc:
       permalink: true
   - admonition
+  - codehilite
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - pymdownx.details
 nav:
   - Overview: index.md
   - getting_started.md

pkg/qliksense/config.go

@@ -106,7 +106,6 @@ func (q *Qliksense) ConfigViewCR() error {
 	if err != nil {
 		return err
 	}
-	fmt.Println(r)
 	oth, err := q.getCurrentCrDependentResourceAsString()
 	if err != nil {
 		return err