Merge pull request #65 from fluxcd/release-v0.0.1

Update controllers to v0.0.1

.github/workflows/docs.yaml

@@ -0,0 +1,27 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - docs*
+      - master
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+      - name: Copy assets
+        run: |
+          cp install/tk.sh docs/install.sh
+          curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/api/source.md > docs/components/source/api.md
+          curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/gitrepositories.md > docs/components/source/gitrepositories.md
+          curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/helmrepositories.md > docs/components/source/helmrepositories.md
+          curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/api/kustomize.md > docs/components/kustomize/api.md
+          curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/spec/v1alpha1/kustomization.md > docs/components/kustomize/kustomization.md
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CUSTOM_DOMAIN: toolkit.fluxcd.io

.github/workflows/e2e.yaml

@@ -30,6 +30,7 @@ jobs:
       - name: Check if working tree is dirty
         run: |
           if [[ $(git diff --stat) != '' ]]; then
+            git diff --stat
             echo 'run make test and commit changes'
             exit 1
           fi

Makefile

@@ -11,7 +11,7 @@ fmt:
 vet:
 	go vet ./...
 
-test: tidy fmt vet
+test: tidy fmt vet docs
 	go test ./... -coverprofile cover.out
 
 build:

README.md

@@ -7,11 +7,6 @@
 
 Experimental toolkit for assembling CD pipelines the GitOps way.
 
-![overview](docs/diagrams/tk-overview.png)
+![overview](docs/diagrams/tk-feature.png)
 
-Components:
-* [Toolkit CLI](docs/cmd/tk.md)
-* [Source Controller](https://github.com/fluxcd/source-controller)
-* [Kustomize Controller](https://github.com/fluxcd/kustomize-controller)
-
-To install the toolkit CLI, follow the [instructions](install/README.md).
+To get started with the toolkit please read the [docs](https://toolkit.fluxcd.io/).

cmd/tk/bootstrap.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/bootstrap_github.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -78,7 +94,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("%s environment variable not found", git.GitHubTokenName)
 	}
 
-	repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "tk", "tk@users.noreply.github.com")
+	repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "tk", ghOwner+"@users.noreply.github.com")
 	if err != nil {
 		return err
 	}

cmd/tk/bootstrap_gitlab.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -18,7 +34,7 @@ var bootstrapGitLabCmd = &cobra.Command{
 	Use:   "gitlab",
 	Short: "Bootstrap GitLab repository",
 	Long: `
-The bootstrap command creates the GitHub repository if it doesn't exists and
+The bootstrap command creates the GitLab repository if it doesn't exists and
 commits the toolkit components manifests to the master branch.
 Then it configure the target cluster to synchronize with the repository.
 If the toolkit components are present on the cluster,
@@ -35,7 +51,7 @@ the bootstrap command will perform an upgrade if needed.`,
   # Run bootstrap for a public repository on a personal account
   bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true 
 
-  # Run bootstrap for a private repo hosted on GitLab server 
+  # Run bootstrap for a private repo hosted on a GitLab server 
   bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
 `,
 	RunE: bootstrapGitLabCmdRun,
@@ -52,7 +68,7 @@ var (
 )
 
 func init() {
-	bootstrapGitLabCmd.Flags().StringVar(&glOwner, "owner", "", "GitLab user or organization name")
+	bootstrapGitLabCmd.Flags().StringVar(&glOwner, "owner", "", "GitLab user or group name")
 	bootstrapGitLabCmd.Flags().StringVar(&glRepository, "repository", "", "GitLab repository name")
 	bootstrapGitLabCmd.Flags().BoolVar(&glPersonal, "personal", false, "is personal repository")
 	bootstrapGitLabCmd.Flags().BoolVar(&glPrivate, "private", true, "is private repository")
@@ -69,7 +85,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("%s environment variable not found", git.GitLabTokenName)
 	}
 
-	repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "tk", "tk@users.noreply.gitlab.com")
+	repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "tk", glOwner+"@users.noreply.gitlab.com")
 	if err != nil {
 		return err
 	}

cmd/tk/check.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -106,35 +122,35 @@ func kubectlCheck(ctx context.Context, version string) bool {
 func kubernetesCheck(version string) bool {
 	cfg, err := clientcmd.BuildConfigFromFlags("", kubeconfig)
 	if err != nil {
-		logFailure("kubernetes client initialization failed: %s", err.Error())
+		logFailure("Kubernetes client initialization failed: %s", err.Error())
 		return false
 	}
 
 	client, err := kubernetes.NewForConfig(cfg)
 	if err != nil {
-		logFailure("kubernetes client initialization failed: %s", err.Error())
+		logFailure("Kubernetes client initialization failed: %s", err.Error())
 		return false
 	}
 
 	ver, err := client.Discovery().ServerVersion()
 	if err != nil {
-		logFailure("kubernetes API call failed %s", err.Error())
+		logFailure("Kubernetes API call failed: %s", err.Error())
 		return false
 	}
 
 	v, err := semver.ParseTolerant(ver.String())
 	if err != nil {
-		logFailure("kubernetes version can't be determined")
+		logFailure("Kubernetes version can't be determined")
 		return false
 	}
 
 	rng, _ := semver.ParseRange(version)
 	if !rng(v) {
-		logFailure("kubernetes version must be %s", version)
+		logFailure("Kubernetes version must be %s", version)
 		return false
 	}
 
-	logSuccess("kubernetes %s %s", v.String(), version)
+	logSuccess("Kubernetes %s %s", v.String(), version)
 	return true
 }
 

cmd/tk/completion.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/create.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/create_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/create_source.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/create_source_git.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -242,7 +258,7 @@ func createSourceGitCmdRun(cmd *cobra.Command, args []string) error {
 	}
 
 	if gitRepository.Status.Artifact != nil {
-		logSuccess("fetched revision %s", gitRepository.Status.Artifact.Revision)
+		logSuccess("fetched revision: %s", gitRepository.Status.Artifact.Revision)
 	} else {
 		return fmt.Errorf("git sync failed, artifact not found")
 	}
@@ -252,7 +268,7 @@ func createSourceGitCmdRun(cmd *cobra.Command, args []string) error {
 
 func generateKeyPair(ctx context.Context) (*ssh.KeyPair, error) {
 	var keyGen ssh.KeyPairGenerator
-	switch sourceGitKeyAlgorithm.String() {
+	switch algorithm := sourceGitKeyAlgorithm.String(); algorithm {
 	case "rsa":
 		keyGen = ssh.NewRSAGenerator(int(sourceGitRSABits))
 	case "ecdsa":
@@ -260,11 +276,11 @@ func generateKeyPair(ctx context.Context) (*ssh.KeyPair, error) {
 	case "ed25519":
 		keyGen = ssh.NewEd25519Generator()
 	default:
-		return nil, fmt.Errorf("unsupported public key algorithm '%s'", sourceGitKeyAlgorithm.String())
+		return nil, fmt.Errorf("unsupported public key algorithm: %s", algorithm)
 	}
 	pair, err := keyGen.Generate()
 	if err != nil {
-		return nil, fmt.Errorf("key pair generation failed: %w", err)
+		return nil, fmt.Errorf("key pair generation failed, error: %w", err)
 	}
 	return pair, nil
 }
@@ -276,7 +292,7 @@ func scanHostKey(ctx context.Context, url *url.URL) ([]byte, error) {
 	}
 	hostKey, err := ssh.ScanHostKey(host, 30*time.Second)
 	if err != nil {
-		return nil, fmt.Errorf("SSH key scan for host '%s' failed: %w", host, err)
+		return nil, fmt.Errorf("SSH key scan for host %s failed, error: %w", host, err)
 	}
 	return hostKey, nil
 }

cmd/tk/delete.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/delete_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/delete_source.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/delete_source_git.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/export.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/export_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/export_source.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/export_source_git.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -109,16 +125,16 @@ func exportGit(source sourcev1.GitRepository) error {
 	return nil
 }
 
-func exportGitCredentials(ctx context.Context, kubeClinet client.Client, source sourcev1.GitRepository) error {
+func exportGitCredentials(ctx context.Context, kubeClient client.Client, source sourcev1.GitRepository) error {
 	if source.Spec.SecretRef != nil {
 		namespacedName := types.NamespacedName{
 			Namespace: source.Namespace,
 			Name:      source.Spec.SecretRef.Name,
 		}
 		var cred corev1.Secret
-		err := kubeClinet.Get(ctx, namespacedName, &cred)
+		err := kubeClient.Get(ctx, namespacedName, &cred)
 		if err != nil {
-			return fmt.Errorf("get secret failed: %w", err)
+			return fmt.Errorf("failed to retrieve secret %s, error: %w", namespacedName.Name, err)
 		}
 
 		exported := corev1.Secret{

cmd/tk/flags.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/get.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/get_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/get_source.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/get_source_git.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -46,7 +62,7 @@ func getSourceGitCmdRun(cmd *cobra.Command, args []string) error {
 		for _, condition := range source.Status.Conditions {
 			if condition.Type == sourcev1.ReadyCondition {
 				if condition.Status != corev1.ConditionFalse {
-					logSuccess("%s last fetched revision %s", source.GetName(), source.Status.Artifact.Revision)
+					logSuccess("%s last fetched revision: %s", source.GetName(), source.Status.Artifact.Revision)
 				} else {
 					logFailure("%s %s", source.GetName(), condition.Message)
 				}

cmd/tk/install.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/log.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import "fmt"

cmd/tk/main.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -115,6 +131,10 @@ func kubeconfigFlag() {
 		rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", "",
 			"absolute path to the kubeconfig file")
 	}
+
+	if len(os.Getenv("KUBECONFIG")) > 0 {
+		kubeconfig = os.Getenv("KUBECONFIG")
+	}
 }
 
 func generateDocs() {
@@ -122,6 +142,7 @@ func generateDocs() {
 	if len(args) > 0 && args[0] == "docgen" {
 		rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", "~/.kube/config",
 			"path to the kubeconfig file")
+		rootCmd.DisableAutoGenTag = true
 		err := doc.GenMarkdownTree(rootCmd, "./docs/cmd")
 		if err != nil {
 			log.Fatal(err)

cmd/tk/resume.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/resume_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/suspend.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/suspend_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/sync.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/sync_kustomization.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/sync_source.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/sync_source_git.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -77,7 +93,7 @@ func syncSourceGitCmdRun(cmd *cobra.Command, args []string) error {
 	}
 
 	if gitRepository.Status.Artifact != nil {
-		logSuccess("fetched revision %s", gitRepository.Status.Artifact.Revision)
+		logSuccess("fetched revision: %s", gitRepository.Status.Artifact.Revision)
 	} else {
 		return fmt.Errorf("git sync failed, artifact not found")
 	}

cmd/tk/uninstall.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (

cmd/tk/utils.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package main
 
 import (
@@ -95,7 +111,7 @@ func (*Utils) execTemplate(obj interface{}, tmpl, filename string) error {
 func (*Utils) kubeClient(config string) (client.Client, error) {
 	cfg, err := clientcmd.BuildConfigFromFlags("", config)
 	if err != nil {
-		return nil, fmt.Errorf("kubernetes client initialization failed: %w", err)
+		return nil, fmt.Errorf("Kubernetes client initialization failed: %w", err)
 	}
 
 	scheme := runtime.NewScheme()
@@ -107,7 +123,7 @@ func (*Utils) kubeClient(config string) (client.Client, error) {
 		Scheme: scheme,
 	})
 	if err != nil {
-		return nil, fmt.Errorf("kubernetes client initialization failed: %w", err)
+		return nil, fmt.Errorf("Kubernetes client initialization failed: %w", err)
 	}
 
 	return kubeClient, nil

docs/_files/flux-icon.svg

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="64px" height="64px" viewBox="0 0 64 64" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 56.3 (81716) - https://sketch.com -->
+    <title>flux-icon</title>
+    <desc>Created with Sketch.</desc>
+    <g id="flux-icon" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Group" transform="translate(11.000000, 2.000000)">
+            <path d="M0.803134615,15.7791346 C-0.246288462,15.0966346 -0.246288462,13.5602885 0.803134615,12.8783654 L20.1819808,0.279519231 C20.7554423,-0.0931730769 21.4944808,-0.0931730769 22.0679423,0.279519231 L41.4473654,12.8783654 C42.4967885,13.5602885 42.4967885,15.0966346 41.4473654,15.7791346 L22.0679423,28.3779808 C21.4944808,28.7506731 20.7554423,28.7506731 20.1819808,28.3779808 L0.803134615,15.7791346 Z" id="Fill-1" fill="#326CE5"></path>
+            <path d="M24.1851346,18.0023077 L25.5293654,18.0023077 C26.3145577,18.0023077 26.8055192,17.1525 26.4126346,16.4728846 L22.0084038,8.84423077 C21.6160962,8.16461538 20.63475,8.16461538 20.2418654,8.84423077 L15.8376346,16.4728846 C15.4453269,17.1525 15.9357115,18.0023077 16.7209038,18.0023077 L18.0657115,18.0023077 C18.6287885,18.0023077 19.0851346,18.4592308 19.0851346,19.0223077 L19.0851346,27.7298077 L19.9874423,28.3165385 C20.6791731,28.7665385 21.5710962,28.7665385 22.2628269,28.3165385 L23.1651346,27.7298077 L23.1651346,19.0223077 C23.1651346,18.4592308 23.6214808,18.0023077 24.1851346,18.0023077" id="Fill-3" fill="#C1D2F7"></path>
+            <path d="M27.8390769,34.8375577 L23.1648462,31.7989038 L23.1648462,33.2389038 C24.6902308,33.8919808 26.2588846,34.4008269 27.8390769,34.8375577" id="Fill-5" fill="#326CE5"></path>
+            <path d="M23.1650769,35.8280192 L23.1650769,37.8495577 C24.7095,38.3209038 26.2723846,38.7080192 27.8191154,39.0893654 C32.8706538,40.3349423 37.6418077,41.5107115 41.4783462,45.3478269 C41.6733462,45.54225 41.8562308,45.7407115 42.0373846,45.93975 C42.4308462,45.1880192 42.2335385,44.1957115 41.4466154,43.6845577 L33.8560385,38.7489808 C32.0133462,38.1409038 30.1360385,37.6759038 28.2806538,37.2189808 C26.5308462,36.7874423 24.8196923,36.3570577 23.1650769,35.8280192" id="Fill-7" fill="#326CE5"></path>
+            <path d="M19.08525,34.1699423 C18.4304423,33.8318654 17.7854423,33.4689808 17.1629423,33.0489808 L15.4269808,34.1774423 C16.5975577,35.0382115 17.8235192,35.7362885 19.08525,36.3212885 L19.08525,34.1699423 Z" id="Fill-9" fill="#326CE5"></path>
+            <path d="M24.8941731,40.6051154 C24.3137885,40.4620385 23.7374423,40.3195385 23.1651346,40.1735769 L23.1651346,42.1605 C23.5885962,42.2666538 24.0114808,42.3722308 24.4326346,42.4760769 C29.4841731,43.7210769 34.2553269,44.8968462 38.0924423,48.7339615 C38.0987885,48.7408846 38.1045577,48.7472308 38.1114808,48.7541538 L39.75225,47.6868462 C39.6524423,47.5824231 39.5584038,47.4751154 39.4545577,47.3718462 C35.2384038,43.1551154 29.9791731,41.8587692 24.8941731,40.6051154" id="Fill-11" fill="#326CE5"></path>
+            <path d="M19.08525,38.9907115 C16.8900577,38.2389808 14.8096731,37.2714808 12.9115962,35.8124423 L11.2119808,36.9178269 C13.6287115,38.9110962 16.3194808,40.1203269 19.08525,41.0168654 L19.08525,38.9907115 Z" id="Fill-13" fill="#326CE5"></path>
+            <path d="M19.08525,43.3809808 C15.3069808,42.3909808 11.7537115,41.18175 8.71794231,38.5388654 L7.04717308,39.6252115 C10.6125577,42.9102115 14.8540962,44.2832885 19.08525,45.3707885 L19.08525,43.3809808 Z" id="Fill-15" fill="#326CE5"></path>
+            <path d="M23.1650769,46.3935 C27.1175769,47.4140769 30.8341154,48.6342692 33.9823846,51.4381154 L35.6439231,50.3581154 C31.9654615,46.9000385 27.5514231,45.5194615 23.1650769,44.4048462 L23.1650769,46.3935 Z" id="Fill-17" fill="#326CE5"></path>
+            <path d="M4.57875,41.2299231 L2.92990385,42.3018462 C2.98759615,42.3612692 3.04009615,42.423 3.09951923,42.4818462 C7.31625,46.6985769 12.5743269,47.9949231 17.6599038,49.2485769 C22.0641346,50.3337692 26.2543269,51.3687692 29.7989423,54.1581923 L31.4893269,53.0591538 C27.4958654,49.6968462 22.7385577,48.5158846 18.1214423,47.3781923 C13.1206731,46.1453077 8.39567308,44.9758846 4.57875,41.2299231" id="Fill-19" fill="#326CE5"></path>
+            <path d="M1.07555769,44.5060962 C0.883442308,44.3139808 0.702865385,44.1184038 0.524019231,43.9216731 C-0.227711538,44.6745577 -0.139442308,45.9726346 0.80325,46.5853269 L6.50959615,50.2955192 C9.03536538,51.3409038 11.6765192,51.9945577 14.2738269,52.6349423 C18.3284423,53.6341731 22.2019038,54.5924423 25.5578654,56.9157115 L27.2834423,55.7930192 C23.4676731,52.9245577 19.0403654,51.8255192 14.7347885,50.7639808 C9.68382692,49.5189808 4.91267308,48.3432115 1.07555769,44.5060962" id="Fill-21" fill="#326CE5"></path>
+            <path d="M19.6441154,58.8342692 C20.0243077,59.0188846 20.3998846,59.2133077 20.7691154,59.4221538 C21.2093077,59.5150385 21.6771923,59.4383077 22.0683462,59.1838846 L23.0260385,58.5613846 C19.9493077,56.5035 16.5287308,55.461 13.1196923,54.5927308 L19.6441154,58.8342692 Z" id="Fill-23" fill="#326CE5"></path>
+        </g>
+    </g>
+</svg>

docs/_static/custom.css

@@ -0,0 +1,24 @@
+@import url("https://fonts.googleapis.com/css?family=Montserrat&display=swap");
+
+body {
+  font-family: "Montserrat", sans-serif;
+}
+
+.md-logo {
+    width: 40px;
+    height: 40px;
+    padding-bottom: 2px;
+    padding-top: 2px;
+}
+.md-logo img {
+    width: 40px;
+    height: 40px;
+}
+
+.md-header, .md-footer-nav {
+    background-image: linear-gradient(45deg, rgb(0, 150, 225) 0%, rgb(27, 141, 226) 24%, rgb(42, 125, 227) 53%, rgb(53, 112, 227) 78%, rgb(53, 112, 227) 100%);
+}
+
+.md-header-nav__title {
+    font-size: .85rem;
+}

docs/cmd/tk.md

@@ -90,4 +90,3 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
 * [tk sync](tk_sync.md)	 - Synchronize commands
 * [tk uninstall](tk_uninstall.md)	 - Uninstall the toolkit components
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_bootstrap.md

@@ -29,4 +29,3 @@ Bootstrap commands
 * [tk bootstrap github](tk_bootstrap_github.md)	 - Bootstrap GitHub repository
 * [tk bootstrap gitlab](tk_bootstrap_gitlab.md)	 - Bootstrap GitLab repository
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_bootstrap_github.md

@@ -67,4 +67,3 @@ tk bootstrap github [flags]
 
 * [tk bootstrap](tk_bootstrap.md)	 - Bootstrap commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_bootstrap_gitlab.md

@@ -5,7 +5,7 @@ Bootstrap GitLab repository
 ### Synopsis
 
 
-The bootstrap command creates the GitHub repository if it doesn't exists and
+The bootstrap command creates the GitLab repository if it doesn't exists and
 commits the toolkit components manifests to the master branch.
 Then it configure the target cluster to synchronize with the repository.
 If the toolkit components are present on the cluster,
@@ -30,7 +30,7 @@ tk bootstrap gitlab [flags]
   # Run bootstrap for a public repository on a personal account
   bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true 
 
-  # Run bootstrap for a private repo hosted on GitLab server 
+  # Run bootstrap for a private repo hosted on a GitLab server 
   bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
 
 ```
@@ -41,7 +41,7 @@ tk bootstrap gitlab [flags]
   -h, --help                help for gitlab
       --hostname string     GitLab hostname (default "gitlab.com")
       --interval duration   sync interval (default 1m0s)
-      --owner string        GitLab user or organization name
+      --owner string        GitLab user or group name
       --path string         repository path, when specified the cluster sync will be scoped to this path
       --personal            is personal repository
       --private             is private repository (default true)
@@ -63,4 +63,3 @@ tk bootstrap gitlab [flags]
 
 * [tk bootstrap](tk_bootstrap.md)	 - Bootstrap commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_check.md

@@ -44,4 +44,3 @@ tk check [flags]
 
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_completion.md

@@ -44,4 +44,3 @@ To configure your bash shell to load completions for each session add to your ba
 
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_create.md

@@ -30,4 +30,3 @@ Create commands
 * [tk create kustomization](tk_create_kustomization.md)	 - Create or update a kustomization resource
 * [tk create source](tk_create_source.md)	 - Create source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_create_kustomization.md

@@ -78,4 +78,3 @@ tk create kustomization [name] [flags]
 
 * [tk create](tk_create.md)	 - Create commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_create_source.md

@@ -29,4 +29,3 @@ Create source commands
 * [tk create](tk_create.md)	 - Create commands
 * [tk create source git](tk_create_source_git.md)	 - Create or update a git source
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_create_source_git.md

@@ -83,4 +83,3 @@ tk create source git [name] [flags]
 
 * [tk create source](tk_create_source.md)	 - Create source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_delete.md

@@ -29,4 +29,3 @@ Delete commands
 * [tk delete kustomization](tk_delete_kustomization.md)	 - Delete kustomization
 * [tk delete source](tk_delete_source.md)	 - Delete sources commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_delete_kustomization.md

@@ -31,4 +31,3 @@ tk delete kustomization [name] [flags]
 
 * [tk delete](tk_delete.md)	 - Delete commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_delete_source.md

@@ -28,4 +28,3 @@ Delete sources commands
 * [tk delete](tk_delete.md)	 - Delete commands
 * [tk delete source git](tk_delete_source_git.md)	 - Delete git source
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_delete_source_git.md

@@ -31,4 +31,3 @@ tk delete source git [name] [flags]
 
 * [tk delete source](tk_delete_source.md)	 - Delete sources commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_export.md

@@ -29,4 +29,3 @@ Export commands
 * [tk export kustomization](tk_export_kustomization.md)	 - Export kustomization in YAML format
 * [tk export source](tk_export_source.md)	 - Export source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_export_kustomization.md

@@ -42,4 +42,3 @@ tk export kustomization [name] [flags]
 
 * [tk export](tk_export.md)	 - Export commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_export_source.md

@@ -29,4 +29,3 @@ Export source commands
 * [tk export](tk_export.md)	 - Export commands
 * [tk export source git](tk_export_source_git.md)	 - Export git sources in YAML format
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_export_source_git.md

@@ -43,4 +43,3 @@ tk export source git [name] [flags]
 
 * [tk export source](tk_export_source.md)	 - Export source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_get.md

@@ -28,4 +28,3 @@ Get commands
 * [tk get kustomizations](tk_get_kustomizations.md)	 - Get kustomizations status
 * [tk get sources](tk_get_sources.md)	 - Get sources commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_get_kustomizations.md

@@ -31,4 +31,3 @@ tk get kustomizations [flags]
 
 * [tk get](tk_get.md)	 - Get commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_get_sources.md

@@ -27,4 +27,3 @@ Get sources commands
 * [tk get](tk_get.md)	 - Get commands
 * [tk get sources git](tk_get_sources_git.md)	 - Get git sources status
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_get_sources_git.md

@@ -31,4 +31,3 @@ tk get sources git [flags]
 
 * [tk get sources](tk_get_sources.md)	 - Get sources commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_install.md

@@ -49,4 +49,3 @@ tk install [flags]
 
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_resume.md

@@ -27,4 +27,3 @@ Resume commands
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 * [tk resume kustomization](tk_resume_kustomization.md)	 - Resume kustomization
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_resume_kustomization.md

@@ -30,4 +30,3 @@ tk resume kustomization [name] [flags]
 
 * [tk resume](tk_resume.md)	 - Resume commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_suspend.md

@@ -27,4 +27,3 @@ Suspend commands
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 * [tk suspend kustomization](tk_suspend_kustomization.md)	 - Suspend kustomization
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_suspend_kustomization.md

@@ -30,4 +30,3 @@ tk suspend kustomization [name] [flags]
 
 * [tk suspend](tk_suspend.md)	 - Suspend commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_sync.md

@@ -28,4 +28,3 @@ Synchronize commands
 * [tk sync kustomization](tk_sync_kustomization.md)	 - Synchronize kustomization
 * [tk sync source](tk_sync_source.md)	 - Synchronize source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_sync_kustomization.md

@@ -43,4 +43,3 @@ tk sync kustomization [name] [flags]
 
 * [tk sync](tk_sync.md)	 - Synchronize commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_sync_source.md

@@ -27,4 +27,3 @@ Synchronize source commands
 * [tk sync](tk_sync.md)	 - Synchronize commands
 * [tk sync source git](tk_sync_source_git.md)	 - Synchronize git source
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_sync_source_git.md

@@ -39,4 +39,3 @@ tk sync source git [name] [flags]
 
 * [tk sync source](tk_sync_source.md)	 - Synchronize source commands
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/cmd/tk_uninstall.md

@@ -47,4 +47,3 @@ tk uninstall [flags]
 
 * [tk](tk.md)	 - Command line utility for assembling Kubernetes CD pipelines
 
-###### Auto generated by spf13/cobra on 18-Jun-2020

docs/components/kustomize/controller.md

@@ -0,0 +1,23 @@
+# Kustomize Controller
+
+The kustomize-controller is a Kubernetes operator,
+specialized in running continuous delivery pipelines for infrastructure and
+workloads defined with Kubernetes manifests and assembled with Kustomize.
+
+![](../../_files/kustomize-controller.png)
+
+Features:
+
+- Reconciles the cluster state from multiple sources (provided by source-controller)
+- Generates manifests with Kustomize (from plain Kubernetes yamls or Kustomize overlays)
+- Validates manifests against Kubernetes API
+- Impersonates service accounts (multi-tenancy RBAC)  
+- Health assessment of the deployed workloads
+- Runs pipelines in a specific order (depends-on relationship)
+- Prunes objects removed from source (garbage collection) 
+- Reports cluster state changes (Slack/Discord)
+
+Links:
+
+- Source code [fluxcd/kustomize-controller](https://github.com/fluxcd/kustomize-controller)
+- Specification [docs](https://github.com/fluxcd/kustomize-controller/tree/master/docs/spec)

docs/components/source/controller.md

@@ -0,0 +1,24 @@
+# Source Controller
+
+The main role of the source management component is to provide a common interface for artifacts acquisition.
+The source API defines a set of Kubernetes objects that cluster admins and various automated operators can
+interact with to offload the Git and Helm repositories operations to a dedicated controller.
+
+![](../../_files/source-controller.png)
+
+Features:
+
+- Validate source definitions
+- Authenticate to sources (SSH, user/password, API token)
+- Validate source authenticity (PGP)
+- Detect source changes based on update policies (semver)
+- Fetch resources on-demand and on-a-schedule
+- Package the fetched resources into a well-known format (tar.gz, yaml)
+- Make the artifacts addressable by their source identifier (sha, version, ts)
+- Make the artifacts available in-cluster to interested 3rd parties
+- Notify interested 3rd parties of source changes and availability (status conditions, events, hooks)
+
+Links:
+
+- Source code [fluxcd/source-controller](https://github.com/fluxcd/source-controller)
+- Specification [docs](https://github.com/fluxcd/source-controller/tree/master/docs/spec)

docs/get-started/index.md

@@ -0,0 +1,366 @@
+# Get started with GitOps Toolkit
+
+## Prerequisites
+
+You will need two Kubernetes clusters version 1.14 or newer and kubectl version 1.18.
+For a quick local test, you can use [Kubernetes kind](https://kind.sigs.k8s.io/docs/user/quick-start/).
+Any other Kubernetes setup will work as well though.
+
+In order to follow the guide you'll need a GitHub account and a 
+[personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
+that can create repositories (check all permissions under `repo`).
+
+Export your GitHub personal access token and username:
+
+```sh
+export GITHUB_TOKEN=<your-token>
+export GITHUB_USER=<your-username>
+```
+
+## Install the toolkit CLI
+
+To install the latest `tk` release run:
+
+```bash
+curl -s https://toolkit.fluxcd.io/install.sh | sudo bash
+```
+
+The install script downloads the tk binary to `/usr/local/bin`.
+Binaries for macOS and Linux AMD64 are available for download on the 
+[release page](https://github.com/fluxcd/toolkit/releases).
+
+To configure your shell to load tk completions add to your bash profile:
+
+```sh
+# ~/.bashrc or ~/.bash_profile
+. <(tk completion)
+```
+
+## GitOps workflow
+
+You'll be using a dedicated Git repository e.g. `fleet-infra` to manage one or more Kubernetes clusters.
+This guide assumes that you have two clusters, one for staging and one for production.
+
+Using the toolkit CLI you'll do the following:
+
+- configure each cluster to synchronise with a directory inside the fleet repository
+- register app sources (git repositories) that contain plain Kubernetes manifests or Kustomize overlays
+- configure app deployments on both clusters (pre-releases on staging, semver releases on production)
+
+## Staging bootstrap
+
+Create the staging cluster using Kubernetes kind or set the kubectl context to an existing cluster:
+
+```sh
+kind create cluster --name staging
+kubectl cluster-info --context kind-staging
+```
+
+Verify that your staging cluster satisfies the prerequisites with:
+
+```text
+$ tk check --pre
+
+► checking prerequisites
+✔ kubectl 1.18.3 >=1.18.0
+✔ kubernetes 1.18.2 >=1.14.0
+✔ prerequisites checks passed
+```
+
+Run the bootstrap command:
+
+```sh
+tk bootstrap github \
+  --owner=$GITHUB_USER \
+  --repository=fleet-infra \
+  --path=staging-cluster \
+  --personal
+```
+
+The bootstrap command creates a repository if one doesn't exist and
+commits the toolkit components manifests to the master branch at the specified path.
+Then it configures the target cluster to synchronize with the specified path inside the repository.
+
+If you wish to create the repository under a GitHub organization:
+
+```sh
+tk bootstrap github \
+  --owner=<organization> \
+  --repository=<repo-name> \
+  --team=<team1-slug> \
+  --team=<team2-slug> \
+  --path=staging-cluster
+```
+
+Example output:
+
+```text
+$ tk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs
+
+► connecting to github.com
+✔ repository created
+✔ devs team access granted
+✔ repository cloned
+✚ generating manifests
+✔ components manifests pushed
+► installing components in gitops-system namespace
+namespace/gitops-system created
+customresourcedefinition.apiextensions.k8s.io/gitrepositories.source.fluxcd.io created
+customresourcedefinition.apiextensions.k8s.io/helmcharts.source.fluxcd.io created
+customresourcedefinition.apiextensions.k8s.io/helmrepositories.source.fluxcd.io created
+customresourcedefinition.apiextensions.k8s.io/kustomizations.kustomize.fluxcd.io created
+customresourcedefinition.apiextensions.k8s.io/profiles.kustomize.fluxcd.io created
+role.rbac.authorization.k8s.io/crd-controller-gitops-system created
+rolebinding.rbac.authorization.k8s.io/crd-controller-gitops-system created
+clusterrolebinding.rbac.authorization.k8s.io/cluster-reconciler-gitops-system created
+service/source-controller created
+deployment.apps/kustomize-controller created
+deployment.apps/source-controller created
+networkpolicy.networking.k8s.io/deny-ingress created
+Waiting for deployment "source-controller" rollout to finish: 0 of 1 updated replicas are available...
+deployment "source-controller" successfully rolled out
+deployment "kustomize-controller" successfully rolled out
+✔ install completed
+► configuring deploy key
+✔ deploy key configured
+► generating sync manifests
+✔ sync manifests pushed
+► applying sync manifests
+◎ waiting for cluster sync
+✔ bootstrap finished
+```
+
+If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [tk bootstrap gitlab](../cmd/tk_bootstrap_gitlab.md).
+
+!!! hint "Idempotency"
+    It is safe to run the bootstrap command as many times as you want.
+    If the toolkit components are present on the cluster,
+    the bootstrap command will perform an upgrade if needed.
+    You can target a specific toolkit [version](https://github.com/fluxcd/toolkit/releases)
+    with `tk bootstrap --version=<semver>`.
+
+## Staging workflow
+
+Clone the repository with:
+
+```sh
+git clone https://github.com/$GITHUB_USER/fleet-infra
+cd fleet-infra
+```
+
+Create a git source pointing to a public repository master branch:
+
+```sh
+tk create source git webapp \
+  --url=https://github.com/stefanprodan/podinfo \
+  --branch=master \
+  --interval=30s \
+  --export > ./staging-cluster/webapp-source.yaml
+```
+
+Create a kustomization for synchronizing the common manifests on the cluster:
+
+```sh
+tk create kustomization webapp-common \
+  --source=webapp \
+  --path="./deploy/webapp/common" \
+  --prune=true \
+  --validate=client \
+  --interval=1h \
+  --export > ./staging-cluster/webapp-common.yaml
+```
+
+Create a kustomization for the backend service that depends on common: 
+
+```sh
+tk create kustomization webapp-backend \
+  --depends-on=webapp-common \
+  --source=webapp \
+  --path="./deploy/webapp/backend" \
+  --prune=true \
+  --validate=client \
+  --interval=10m \
+  --health-check="Deployment/backend.webapp" \
+  --health-check-timeout=2m \
+  --export > ./staging-cluster/webapp-backend.yaml
+```
+
+Create a kustomization for the frontend service that depends on backend: 
+
+```sh
+tk create kustomization webapp-frontend \
+  --depends-on=webapp-backend \
+  --source=webapp \
+  --path="./deploy/webapp/frontend" \
+  --prune=true \
+  --validate=client \
+  --interval=10m \
+  --health-check="Deployment/frontend.webapp" \
+  --health-check-timeout=2m \
+  --export > ./staging-cluster/webapp-frontend.yaml
+```
+
+Push changes to origin:
+
+```sh
+git add -A && git commit -m "add staging webapp" && git push
+```
+
+In about 30s the synchronization should start:
+
+```text
+$ watch tk get kustomizations
+
+✔ gitops-system last applied revision master/35d5765a1acb9e9ce66cad7274c6fe03eee1e8eb
+✔ webapp-backend reconciling
+✔ webapp-common last applied revision master/f43f9b2eb6766e07f318d266a99d2ec7c940b0cf
+✗ webapp-frontend dependency 'gitops-system/webapp-backend' is not ready
+```
+
+When the synchronization finishes you can check that the webapp services are running:
+
+```text
+$ kubectl -n webapp get deployments,services
+
+NAME                       READY   UP-TO-DATE   AVAILABLE   AGE
+deployment.apps/backend    1/1     1            1           4m1s
+deployment.apps/frontend   1/1     1            1           3m31s
+
+NAME               TYPE        CLUSTER-IP    EXTERNAL-IP   PORT(S)             AGE
+service/backend    ClusterIP   10.52.10.22   <none>        9898/TCP,9999/TCP   4m1s
+service/frontend   ClusterIP   10.52.9.85    <none>        80/TCP              3m31s
+```
+
+!!! tip
+    From this moment forward, any changes made to the webapp
+    Kubernetes manifests in the master branch will be synchronised with the staging cluster.
+
+If a Kubernetes manifest is removed from the webapp repository, the reconciler will remove it from your cluster.
+If you delete a kustomization from the `fleet-infra` repo, the reconciler will remove all Kubernetes objects that
+were previously applied from that kustomization.
+
+If you alter the webapp deployment using `kubectl edit`, the changes will be reverted to match
+the state described in git. When dealing with an incident, you can pause the recitation of a
+kustomization with `tk suspend kustomization <name>`. Once the debugging session
+is over, you can re-enable the reconciliation with `tk resume kustomization <name>`.
+
+## Production bootstrap 
+
+On production clusters, you may wish to deploy stable releases of an application.
+When creating a git source instead of a branch, you can specify a git tag or a semver expression. 
+
+Create the production cluster using Kubernetes kind or set the kubectl context to an existing cluster:
+
+```sh
+kind create cluster --name production
+kubectl cluster-info --context kind-production
+```
+
+Run the bootstrap for the production environment:
+
+```sh
+tk bootstrap github \
+  --owner=$GITHUB_USER \
+  --repository=fleet-infra \
+  --path=prod-cluster \
+  --personal
+```
+
+Pull the changes locally:
+
+```sh
+git pull
+```
+
+## Production workflow
+
+Create a git source using a semver range to target stable releases:
+
+```sh
+tk create source git webapp \
+  --url=https://github.com/stefanprodan/podinfo \
+  --tag-semver=">=4.0.0 <4.0.2" \
+  --interval=30s \
+  --export > ./prod-cluster/webapp-source.yaml
+```
+
+Create a kustomization for webapp pointing to the production overlay:
+
+```sh
+tk create kustomization webapp \
+  --source=webapp \
+  --path="./deploy/overlays/production" \
+  --prune=true \
+  --validate=client \
+  --interval=10m \
+  --health-check="Deployment/frontend.production" \
+  --health-check="Deployment/backend.production" \
+  --health-check-timeout=2m \
+  --export > ./prod-cluster/webapp-production.yaml
+``` 
+
+Push changes to origin:
+
+```sh
+git add -A && git commit -m "add prod webapp" && git push
+```
+
+List git sources:
+
+```text
+$ tk get sources git
+
+✔ gitops-system last fetched revision master/99072ee132abdead8b7799d7891eae2f524eb73d
+✔ webapp last fetched revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
+```
+
+The kubectl equivalent is `kubectl -n gitops-system get gitrepositories`.
+
+List kustomization:
+
+```text
+$ tk get kustomizations
+
+✔ gitops-system last applied revision master/99072ee132abdead8b7799d7891eae2f524eb73d
+✔ webapp last applied revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
+```
+
+The kubectl equivalent is `kubectl -n gitops-system get kustomizations`.
+
+If you want to upgrade to the latest 4.x version, you can change the semver expression to:
+
+```sh
+tk create source git webapp \
+  --url=https://github.com/stefanprodan/podinfo \
+  --tag-semver=">=4.0.0 <5.0.0" \
+  --interval=30s \
+  --export > ./prod-cluster/webapp-source.yaml
+
+git add -A && git commit -m "update prod webapp" && git push
+```
+
+Trigger a git sync:
+
+```text
+$ tk sync ks gitops-system --with-source 
+
+► annotating source gitops-system
+✔ source annotated
+◎ waiting for git sync
+✔ git sync completed
+✔ fetched revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
+◎ waiting for kustomization sync
+✔ kustomization sync completed
+✔ applied revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
+```
+
+The kubectl equivalent is `kubectl -n gitops-system annotate gitrepository/gitops-system source.fluxcd.io/syncAt="$(date +%s)"`.
+
+Wait for the webapp to be upgraded:
+
+```text
+$ watch tk get kustomizations
+
+✔ gitops-system last applied revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9
+✔ webapp last applied revision 4.0.5/f43f9b2eb6766e07f318d266a99d2ec7c940b0cf
+```

docs/index.md

@@ -0,0 +1,46 @@
+# GitOps Toolkit
+
+The GitOps Toolkit is a set of composable APIs and specialized tools
+that can be used to build a Continuous Delivery platform on top of Kubernetes.
+
+These tools are built with Kubernetes controller-runtime libraries and they
+can be dynamically configured with Kubernetes custom resources either by
+cluster admins or by other automated tools.
+The GitOps Toolkit components interact with each other via Kubernetes
+events and are responsible for the reconciliation of their designated API objects. 
+
+!!! hint "Work in Progress"
+    We envision a future where **Flux v2** and **Helm Operator v2** will be assembled from
+    the GitOps Toolkit components. The Flux CD team is looking for feedback and help as 
+    the toolkit is in an active experimentation phase.
+    If you wish to take part in this quest please reach out to us on Slack and GitHub.
+
+![overview](diagrams/tk-feature.png)
+
+Target features:
+
+- Source management
+- Kustomize and Helm support 
+- Event-based and on-a-schedule reconciliation
+- Role-based reconciliation (multi-tenancy)
+- Health assessment (clusters and workloads)
+- Dependency management (infra and workloads)
+- Alerting to external systems (webhook senders)
+- External events handling (webhook receivers)
+- Source write-back (automated patching)
+- Policy driven validation (OPA, admission controllers)
+- Seamless integration with Git providers (GitHub, GitLab, BitBucket)
+- Interoperability with workflow providers (GitHub Actions, Tekton, Argo)
+- Interoperability with CAPI providers
+
+Components:
+
+- [Toolkit CLI](https://github.com/fluxcd/toolkit)
+- [Source Controller](components/source/controller.md)
+    - [GitRepository CRD](components/source/gitrepositories.md)
+    - [HelmRepository CRD](components/source/helmrepositories.md)
+- [Kustomize Controller](components/kustomize/controller.md)
+    - [Kustomization CRD](components/kustomize/kustomization.md)
+- Helm Controller (TBA)
+
+To get started with the toolkit please follow this [guide](get-started/index.md).

docs/roadmap/index.md

@@ -0,0 +1,81 @@
+# Roadmap
+
+!!! hint "Work in Progress"
+    We will be building the roadmap together with the Flux community,
+    our end-users and everyone who is interested in integrating with us.
+    So a lot of this is still TBD - read this as our shopping list of
+    ideas after some brainstorming as Flux maintainers.
+
+## The road to Flux v2
+
+### Flux read-only feature parity
+
+This would be the first stepping stone: we want the GitOps Toolkit to be on-par with today's Flux in
+[read-only mode](https://github.com/fluxcd/flux/blob/master/docs/faq.md#can-i-run-flux-with-readonly-git-access)
+and [FluxCloud](https://github.com/justinbarrick/fluxcloud) notifications.
+
+Goals
+
+- Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests
+- Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays
+- Offer a dedicated component for forwarding events to external messaging platforms 
+
+Non-Goals
+
+- Migrate users that are using Flux to run custom scripts with `flux.yaml`
+- Automate the migration of `flux.yaml` kustomize users
+
+Tasks
+
+- Review the git source and kustomize APIs
+- Design the events API
+- Implement events in source and kustomize controllers
+- Implement Prometheus metrics in source and kustomize controllers
+- Make the kustomize-controller apply/gc events on-par with Flux v1 apply events
+- Design the notifications and events filtering API
+- Implement a notification controller for Slack, MS Teams, Discord, Rocket
+- Implement the migration command in tk
+- Create a migration guide for `flux.yaml` kustomize users
+
+### Flux image update feature parity
+
+Goals
+
+- Offer a dedicated component that can replace Flux v1 image update feature
+
+Non-Goals
+
+- Maintain backwards compatibility with Flux v1 annotations
+
+Tasks
+
+- Design the Git push API
+- Implement Git push in source controller
+- Design the image scanning API
+- Implement an image scanning controller
+- Design the manifests patching component
+- Implement the image scan/patch/push workflow
+- Integrate the new components in the toolkit assembler
+- Create a migration guide from Flux annotations
+
+## The road to Helm Operator v2
+
+### Helm v3 feature parity
+
+Goals
+
+- Offer a migration guide for those that are using Helm Operator with Helm v3 and Helm repositories
+
+Non-Goals
+
+- Migrate users that are using Helm v2
+- Migrate users that are using Helm charts from Git
+
+Tasks
+
+- Review the Helm release, chart and repository APIs
+- Design Helm releases based on source API
+- Implement a Helm controller for Helm v3 covering all the current release options
+- Implement events in Helm controller
+- Implement Prometheus metrics in Helm controller
+- Create a migration guide for Helm Operator users

go.mod

@@ -4,8 +4,8 @@ go 1.14
 
 require (
 	github.com/blang/semver v3.5.1+incompatible
-	github.com/fluxcd/kustomize-controller v0.0.1-beta.2
-	github.com/fluxcd/source-controller v0.0.1-beta.2
+	github.com/fluxcd/kustomize-controller v0.0.1
+	github.com/fluxcd/source-controller v0.0.1
 	github.com/go-git/go-git/v5 v5.0.0
 	github.com/golang/protobuf v1.4.2 // indirect
 	github.com/google/go-github/v32 v32.0.0

go.sum

@@ -168,10 +168,10 @@ github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d h1:105gxyaGwC
 github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d/go.mod h1:ZZMPRZwes7CROmyNKgQzC3XPs6L/G2EJLHddWejkmf4=
 github.com/fatih/camelcase v1.0.0/go.mod h1:yN2Sb0lFhZJUdVvtELVWefmrXpuZESvPmqwoZc+/fpc=
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
-github.com/fluxcd/kustomize-controller v0.0.1-beta.2 h1:3EM2OFR9z8FiILDgzqHHqzSx3mO4KT8xG1gKTevD42E=
-github.com/fluxcd/kustomize-controller v0.0.1-beta.2/go.mod h1:mLeipvpQkyof6b5IHNtqeA8CmbjfVIf92UyKkpeBY98=
-github.com/fluxcd/source-controller v0.0.1-beta.2 h1:XOtc+tSf/8Q0bTVla2L5FdCMMjJWFSPWX/o4/h4OUv0=
-github.com/fluxcd/source-controller v0.0.1-beta.2/go.mod h1:tmscNdCxEt7+Xt2g1+bI38hMPw2leYMFAaCn4UlMGuw=
+github.com/fluxcd/kustomize-controller v0.0.1 h1:F2wg9c5nMUEnPHgs44HMY1/2UAXXaYcmpj7WeOzf9p0=
+github.com/fluxcd/kustomize-controller v0.0.1/go.mod h1:sSIy+Y924OGHW2anzZvD53BbgjSOO4mONTTG2+UTEhM=
+github.com/fluxcd/source-controller v0.0.1 h1:17/b/Zcb3OUkUoo03W+L7TGwkCKG23K9HrgL+d5WMXE=
+github.com/fluxcd/source-controller v0.0.1/go.mod h1:tmscNdCxEt7+Xt2g1+bI38hMPw2leYMFAaCn4UlMGuw=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 h1:BHsljHzVlRcyQhjrss6TZTdY2VfCqZPbv5k3iBFa2ZQ=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=

install/README.md

@@ -15,6 +15,12 @@ The install script does the following:
 * copies the tk binary to `/usr/local/bin`
 * removes the temporary directory
 
+If you want to use tk as a kubectl plugin, rename the binary to `kubectl-tk`:
+
+```sh
+mv /usr/local/bin/tk /usr/local/bin/kubectl-tk
+```
+
 ## Build from source
 
 Clone the repository:

manifests/bases/kustomize-controller/kustomization.yaml

@@ -1,5 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-- github.com/fluxcd/kustomize-controller/config//crd?ref=v0.0.1-beta.2
-- github.com/fluxcd/kustomize-controller/config//manager?ref=v0.0.1-beta.2
+- github.com/fluxcd/kustomize-controller/config//crd?ref=v0.0.1
+- github.com/fluxcd/kustomize-controller/config//manager?ref=v0.0.1

manifests/bases/source-controller/kustomization.yaml

@@ -1,5 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-- github.com/fluxcd/source-controller/config//crd?ref=v0.0.1-beta.2
-- github.com/fluxcd/source-controller/config//manager?ref=v0.0.1-beta.2
+- github.com/fluxcd/source-controller/config//crd?ref=v0.0.1
+- github.com/fluxcd/source-controller/config//manager?ref=v0.0.1

mkdocs.yml

@@ -0,0 +1,81 @@
+site_name: GitOps Toolkit
+site_description: Documentation for GitOps Toolkit.
+site_author: The Flux CD contributors
+site_url: https://fluxcd.github.io/toolkit/
+
+repo_name: fluxcd/toolkit
+repo_url: https://github.com/fluxcd/toolkit
+edit_uri: ""
+
+theme:
+  name: material
+  logo: _files/flux-icon@2x.png
+  language: en
+  palette:
+    primary: blue
+    accent: indigo
+
+docs_dir: docs
+
+extra_css:
+  - _static/custom.css
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true
+  - pymdownx.superfences:
+      highlight_code: true
+  - pymdownx.tabbed
+
+nav:
+  - Introduction: index.md
+  - Get Started: get-started/index.md
+  - Toolkit Components:
+    - Source Controller:
+      - Overview: components/source/controller.md
+      - GitRepository CRD: components/source/gitrepositories.md
+      - HelmRepository CRD: components/source/helmrepositories.md
+      - Source API Reference: components/source/api.md
+    - Kustomize Controller:
+      - Overview: components/kustomize/controller.md
+      - Kustomization CRD: components/kustomize/kustomization.md
+      - Kustomize API Reference: components/kustomize/api.md
+  - Toolkit CLI:
+    - Overview: cmd/tk.md
+    - Bootstrap: cmd/tk_bootstrap.md
+    - Bootstrap github: cmd/tk_bootstrap_github.md
+    - Bootstrap gitlab: cmd/tk_bootstrap_gitlab.md
+    - Check: cmd/tk_check.md
+    - Create: cmd/tk_create.md
+    - Create kustomization: cmd/tk_create_kustomization.md
+    - Create source: cmd/tk_create_source.md
+    - Create source git: cmd/tk_create_source_git.md
+    - Delete: cmd/tk_delete.md
+    - Delete kustomization: cmd/tk_delete_kustomization.md
+    - Delete source: cmd/tk_delete_source.md
+    - Delete source git: cmd/tk_delete_source_git.md
+    - Export: cmd/tk_export.md
+    - Export kustomization: cmd/tk_export_kustomization.md
+    - Export source: cmd/tk_export_source.md
+    - Export source git: cmd/tk_export_source_git.md
+    - Get: cmd/tk_get.md
+    - Get kustomizations: cmd/tk_get_kustomizations.md
+    - Get sources: cmd/tk_get_sources.md
+    - Get sources git: cmd/tk_get_sources_git.md
+    - Install: cmd/tk_install.md
+    - Resume: cmd/tk_resume.md
+    - Resume kustomization: cmd/tk_resume_kustomization.md
+    - Suspend: cmd/tk_suspend.md
+    - Suspend kustomization: cmd/tk_suspend_kustomization.md
+    - Sync: cmd/tk_sync.md
+    - Sync kustomization: cmd/tk_sync_kustomization.md
+    - Sync source: cmd/tk_sync_source.md
+    - Sync source git: cmd/tk_sync_source_git.md
+    - Uninstall: cmd/tk_uninstall.md
+  - Roadmap: roadmap/index.md

pkg/git/provider.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package git
 
 import "context"

pkg/git/provider_github.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package git
 
 import (
@@ -61,7 +77,7 @@ func (p *GithubProvider) CreateRepository(ctx context.Context, r *Repository) (b
 	})
 	if err != nil {
 		if !strings.Contains(err.Error(), "name already exists on this account") {
-			return false, fmt.Errorf("create repository error: %w", err)
+			return false, fmt.Errorf("failed to create repository, error: %w", err)
 		}
 	} else {
 		return true, nil
@@ -79,13 +95,13 @@ func (p *GithubProvider) AddTeam(ctx context.Context, r *Repository, name, permi
 	// check team exists
 	_, _, err = gh.Teams.GetTeamBySlug(ctx, r.Owner, name)
 	if err != nil {
-		return false, fmt.Errorf("get team %s error: %w", name, err)
+		return false, fmt.Errorf("failed to retrieve team '%s', error: %w", name, err)
 	}
 
 	// check if team is assigned to the repo
 	_, resp, err := gh.Teams.IsTeamRepoBySlug(ctx, r.Owner, name, r.Owner, r.Name)
 	if resp == nil && err != nil {
-		return false, fmt.Errorf("is team %s error: %w", name, err)
+		return false, fmt.Errorf("failed to determine if team '%s' is assigned to the repository, error: %w", name, err)
 	}
 
 	// add team to the repo
@@ -94,7 +110,7 @@ func (p *GithubProvider) AddTeam(ctx context.Context, r *Repository, name, permi
 			Permission: permission,
 		})
 		if err != nil {
-			return false, fmt.Errorf("add team %s error: %w", name, err)
+			return false, fmt.Errorf("failed to add team '%s' to the repository, error: %w", name, err)
 		}
 		return true, nil
 	}
@@ -112,10 +128,10 @@ func (p *GithubProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 	// list deploy keys
 	keys, resp, err := gh.Repositories.ListKeys(ctx, r.Owner, r.Name, nil)
 	if err != nil {
-		return false, fmt.Errorf("list deploy keys error: %w", err)
+		return false, fmt.Errorf("failed to list deploy keys, error: %w", err)
 	}
 	if resp.StatusCode >= 300 {
-		return false, fmt.Errorf("list deploy keys failed with status code: %s", resp.Status)
+		return false, fmt.Errorf("failed to list deploy keys (status code: %s)", resp.Status)
 	}
 
 	// check if the key exists
@@ -136,10 +152,10 @@ func (p *GithubProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 	if existingKey != nil {
 		resp, err := gh.Repositories.DeleteKey(ctx, r.Owner, r.Name, *existingKey.ID)
 		if err != nil {
-			return false, fmt.Errorf("delete deploy key error: %w", err)
+			return false, fmt.Errorf("failed to delete deploy key '%s', error: %w", keyName, err)
 		}
 		if resp.StatusCode >= 300 {
-			return false, fmt.Errorf("delete deploy key failed with status code: %s", resp.Status)
+			return false, fmt.Errorf("failed to delete deploy key '%s' (status code: %s)", keyName, resp.Status)
 		}
 	}
 
@@ -152,7 +168,7 @@ func (p *GithubProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 			ReadOnly: &isReadOnly,
 		})
 		if err != nil {
-			return false, fmt.Errorf("create deploy key error: %w", err)
+			return false, fmt.Errorf("failed to create deploy key '%s', error: %w", keyName, err)
 		}
 		return true, nil
 	}

pkg/git/provider_gitlab.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package git
 
 import (
@@ -43,7 +59,7 @@ func (p *GitLabProvider) CreateRepository(ctx context.Context, r *Repository) (b
 	if !p.IsPersonal {
 		groups, _, err := gl.Groups.ListGroups(&gitlab.ListGroupsOptions{Search: gitlab.String(r.Owner)}, gitlab.WithContext(ctx))
 		if err != nil {
-			return false, fmt.Errorf("list groups error: %w", err)
+			return false, fmt.Errorf("failed to list groups, error: %w", err)
 		}
 
 		if len(groups) > 0 {
@@ -58,7 +74,7 @@ func (p *GitLabProvider) CreateRepository(ctx context.Context, r *Repository) (b
 
 	projects, _, err := gl.Projects.ListProjects(&gitlab.ListProjectsOptions{Search: gitlab.String(r.Name)}, gitlab.WithContext(ctx))
 	if err != nil {
-		return false, fmt.Errorf("list projects error: %w", err)
+		return false, fmt.Errorf("failed to list projects, error: %w", err)
 	}
 
 	if len(projects) == 0 {
@@ -71,7 +87,7 @@ func (p *GitLabProvider) CreateRepository(ctx context.Context, r *Repository) (b
 
 		_, _, err := gl.Projects.CreateProject(p)
 		if err != nil {
-			return false, fmt.Errorf("create project error: %w", err)
+			return false, fmt.Errorf("failed to create project, error: %w", err)
 		}
 		return true, nil
 	}
@@ -95,7 +111,7 @@ func (p *GitLabProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 	var projId int
 	projects, _, err := gl.Projects.ListProjects(&gitlab.ListProjectsOptions{Search: gitlab.String(r.Name)}, gitlab.WithContext(ctx))
 	if err != nil {
-		return false, fmt.Errorf("list projects error: %w", err)
+		return false, fmt.Errorf("failed to list projects, error: %w", err)
 	}
 	if len(projects) > 0 {
 		projId = projects[0].ID
@@ -106,7 +122,7 @@ func (p *GitLabProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 	// check if the key exists
 	keys, _, err := gl.DeployKeys.ListProjectDeployKeys(projId, &gitlab.ListProjectDeployKeysOptions{})
 	if err != nil {
-		return false, fmt.Errorf("list keys error: %w", err)
+		return false, fmt.Errorf("failed to list deploy keys, error: %w", err)
 	}
 
 	shouldCreateKey := true
@@ -126,7 +142,7 @@ func (p *GitLabProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 	if existingKey != nil {
 		_, err := gl.DeployKeys.DeleteDeployKey(projId, existingKey.ID, gitlab.WithContext(ctx))
 		if err != nil {
-			return false, fmt.Errorf("delete key error: %w", err)
+			return false, fmt.Errorf("failed to delete deploy key '%s', error: %w", keyName, err)
 		}
 	}
 
@@ -138,7 +154,7 @@ func (p *GitLabProvider) AddDeployKey(ctx context.Context, r *Repository, key, k
 			CanPush: gitlab.Bool(false),
 		}, gitlab.WithContext(ctx))
 		if err != nil {
-			return false, fmt.Errorf("add key error: %w", err)
+			return false, fmt.Errorf("failed to create deploy key '%s', error: %w", keyName, err)
 		}
 		return true, nil
 	}

pkg/git/repository.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package git
 
 import (

pkg/ssh/host_key.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package ssh
 
 import (

pkg/ssh/key_pair.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2020 The Flux CD contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package ssh
 
 import (