resolves #101 and #146

gentele · gentele · commit b029d2de2761 · 2018-09-06T16:09:40.000+02:00
diff --git a/cmd/add.go b/cmd/add.go
@@ -13,12 +13,11 @@ import (
 
 // AddCmd holds the information needed for the add command
 type AddCmd struct {
-	flags         *AddCmdFlags
-	syncFlags     *addSyncCmdFlags
-	portFlags     *addPortCmdFlags
-	dsConfig      *v1.DevSpaceConfig
-	privateConfig *v1.PrivateConfig
-	workdir       string
+	flags     *AddCmdFlags
+	syncFlags *addSyncCmdFlags
+	portFlags *addPortCmdFlags
+	dsConfig  *v1.DevSpaceConfig
+	workdir   string
 }
 
 // AddCmdFlags holds the possible flags for the add command
@@ -128,14 +127,14 @@ func (cmd *AddCmd) RunAddSync(cobraCmd *cobra.Command, args []string) {
 		log.Fatalf("Error parsing selectors: %s", err.Error())
 	}
 
-	excludedPaths := make([]*string, 0, 0)
+	excludedPaths := make([]string, 0, 0)
 
 	if cmd.syncFlags.ExcludedPaths != "" {
 		excludedPathStrings := strings.Split(cmd.syncFlags.ExcludedPaths, ",")
 
 		for _, v := range excludedPathStrings {
 			excludedPath := strings.TrimSpace(v)
-			excludedPaths = append(excludedPaths, &excludedPath)
+			excludedPaths = append(excludedPaths, excludedPath)
 		}
 	}
 
@@ -144,7 +143,7 @@ func (cmd *AddCmd) RunAddSync(cobraCmd *cobra.Command, args []string) {
 		LabelSelector: labelSelectorMap,
 		ContainerPath: configutil.String(cmd.syncFlags.ContainerPath),
 		LocalSubPath:  configutil.String(cmd.syncFlags.LocalPath),
-		ExcludeRegex:  excludedPaths,
+		ExcludePaths:  excludedPaths,
 	})
 
 	err = configutil.SaveConfig()
diff --git a/cmd/install.go b/cmd/install.go
@@ -17,12 +17,11 @@ import (
 
 // InstallCmd is a struct that defines a command call for "install"
 type InstallCmd struct {
-	flags         *InstallCmdFlags
-	helm          *helmClient.HelmClientWrapper
-	kubectl       *kubernetes.Clientset
-	privateConfig *v1.PrivateConfig
-	dsConfig      *v1.DevSpaceConfig
-	workdir       string
+	flags    *InstallCmdFlags
+	helm     *helmClient.HelmClientWrapper
+	kubectl  *kubernetes.Clientset
+	dsConfig *v1.DevSpaceConfig
+	workdir  string
 }
 
 // InstallCmdFlags are the flags available for the install-command
diff --git a/cmd/list.go b/cmd/list.go
@@ -107,12 +107,12 @@ func (cmd *ListCmd) RunListSync(cobraCmd *cobra.Command, args []string) {
 
 		excludedPaths := ""
 
-		for _, v := range value.ExcludeRegex {
+		for _, v := range value.ExcludePaths {
 			if len(excludedPaths) > 0 {
 				excludedPaths += ", "
 			}
 
-			excludedPaths += *v
+			excludedPaths += v
 		}
 
 		syncPaths = append(syncPaths, []string{
diff --git a/cmd/up.go b/cmd/up.go
@@ -368,11 +368,14 @@ func (cmd *UpCmd) startSync() []*synctool.SyncConfig {
 				log.Panicf("Unable to list devspace pods: %s", err.Error())
 			} else if pod != nil {
 				syncConfig := &synctool.SyncConfig{
-					Kubectl:   cmd.kubectl,
-					Pod:       pod,
-					Container: &pod.Spec.Containers[0],
-					WatchPath: absLocalPath,
-					DestPath:  *syncPath.ContainerPath,
+					Kubectl:              cmd.kubectl,
+					Pod:                  pod,
+					Container:            &pod.Spec.Containers[0],
+					WatchPath:            absLocalPath,
+					DestPath:             *syncPath.ContainerPath,
+					ExcludePaths:         syncPath.ExcludePaths,
+					DownloadExcludePaths: syncPath.DownloadExcludePaths,
+					UploadExcludePaths:   syncPath.UploadExcludePaths,
 				}
 
 				err = syncConfig.Start()
diff --git a/docs/.devspace/.gitignore b/docs/.devspace/.gitignore
@@ -1,3 +1,2 @@
 logs/
-private.yaml
-cache.yaml
+overwrite.yaml
diff --git a/docs/.devspace/private.yaml b/docs/.devspace/private.yaml
@@ -0,0 +1,18 @@
+version: v1
+release:
+  name: devspace-docs
+  namespace: devspace-docs
+  latestBuild: "2018-08-27T17:32:42.5568625+02:00"
+  latestImage: 10.99.117.105:5000/devspace-docs:vkY31ug8IQ
+registry:
+  release:
+    name: devspace-registry
+    namespace: devspace-docs
+    latestBuild: ""
+    latestImage: ""
+  user:
+    username: user-xNAsk
+    password: tY2XpapTMUjt
+cluster:
+  tillerNamespace: devspace-docs
+  useKubeConfig: true
diff --git a/docs/docs/configuration/config.yaml.md b/docs/docs/configuration/config.yaml.md
@@ -5,40 +5,106 @@ title: /.devspace/config.yaml
 This is an example of a [.devspace/config.yaml](#)
 ```yaml
 version: v1
-portForwarding:
-- resourceType: pod
-  labelSelector:
-    release: my-app
-  portMappings:
-  - localPort: 3000
-    remotePort: 3000
-  - localPort: 8080
-    remotePort: 80
-syncPath:
-- resourceType: pod
-  labelSelector:
-    release: my-app
-  localSubPath: ./
-  containerPath: /app
-registry:
-  secrets:
-    htpasswd: ""
+devSpace:
+  release:
+    name: devspace-cloud-com
+    namespace: dev-gentele
+  portForwarding:
+  - resourceType: pod
+    labelSelector:
+      release: my-app
+    portMappings:
+    - localPort: 3000
+      remotePort: 3000
+    - localPort: 8080
+      remotePort: 80
+  sync:
+  - resourceType: pod
+    labelSelector:
+      release: my-app
+    localSubPath: ./
+    containerPath: /app
+image:
+  name: devspace
+services:
+  registry:
+    internal:
+      release:
+        name: devspace-registry
+        namespace: dev-gentele
+    user:
+      username: user-XXXXX
+      password: XXXXXXXXXX
+  tiller:
+    release:
+      namespace: dev-gentele
+cluster:
+  useKubeConfig: true
+
 ```
 A [.devspace/config.yaml](#) contains any public/shared configuration for running a DevSpace for the respective project. It is highly recommended to put this file under version control (e.g. git add).
 
-## Port Forwarding
+## devspace
+Defines your DevSpace including everything related to portForwarding, sync, and the release config.
+
+### devspace.release
+Defines how the DevSpace is deployed to your cluster. See [Type: Release](#type-release) for details.
+
+### devspace.portForwarding
 To access applications running inside a DevSpace, the DevSpace CLI allows to configure port forwardings. A port forwarding consists of the following:
 - `resourceType` (currently only `pod` is supported)
 - `labelSelector` (usually the release/app name)
 - a list of `portMappings` (each specifying a `localPort` on localhost and a `remotePort` within the DevSpace)
 
 In the example above, you could open `localhost:8080` inside your browser to see the output of the application listening on port 80 within your DevSpace.
 
-## Sync Paths
-To comfortably sync code to a DevSpace, the DevSpace CLI allows to configure sync paths. A sync path consists of the following:
+### devspace.sync
+To comfortably sync code to a DevSpace, the DevSpace CLI allows to configure real-time code synchronizations. A sync config consists of the following:
 - `resourceType` (currently only `pod` is supported)
 - `labelSelector` (usually the release/app name)
 - `localSubPath` (relative to your local project root)
 - `containerPath` (absolute path within your DevSpace)
+- `excludePaths` (for excluding files/folders from sync in .gitignore syntax)
+- `DownloadExcludePaths` (for excluding files/folders from download in .gitignore syntax)
+- `UploadExcludePaths` (for excluding files/folders from upload in .gitignore syntax)
 
 In the example above, the entire code within the project would be synchronized with the folder `/app` inside the DevSpace.
+
+## image
+An image is defined by:
+- `name` of the image that is being pushed to the registry
+- `tag` stating the latest tag pushed to the registry
+- `buildTime` (time of the latest image build process, i.e. docker build)
+
+## services
+Defines additional services for your DevSpace.
+
+### services.registry
+The `registry` field specifies:
+- `external` tells the DevSpace CLI to push to an external registry (format: myregistry.com:port)
+- `internal` defines a private cluster-internal registry by defining a `release` for it
+- `user` credentials (`username`, `password`) for pushing to / pulling from the registry
+- `insecure` flag to allow pushing to registries without HTTPS
+
+### services.tiller
+The `tiller` service is defined by:
+- `release` definition for tiller (see [Type: Release](#type-release))
+- `appNamespaces` defining a list of namespace that tiller may deploy applications to
+
+## cluster
+The `cluster` field specifies:
+- `useKubeConfig` (yes to use the credentials defined in $HOME/.kube/config)
+
+If `useKubeConfig: false` is used, the following fields need to be specified:
+- `apiServer` (Kubernetes API-Server URL)
+- `caCert` (CaCert for the Kubernetes API-Server in PEM format)
+- `user` specifying the following: 
+  - `username`
+  - `clientCert` (PEM format)
+  - `clientKey` (PEM format)
+
+## Type: Release
+A `release` is specified through:
+- `name` of the release
+- `namespace` to deploy the release to
+- `values` that are set during the deployment (contents of the values.yaml in helm)
diff --git a/docs/docs/configuration/overwrite.yaml.md b/docs/docs/configuration/overwrite.yaml.md
@@ -0,0 +1,28 @@
+---
+title: /.devspace/overwrite.yaml
+---
+
+This is an example of the [.devspace/overwrite.yaml](#)
+
+```yaml
+version: v1
+release:
+  name: devspace-docs
+  namespace: devspace-docs
+  latestBuild: "2018-08-27T17:32:42.5568625+02:00"
+  latestImage: 10.99.117.105:5000/devspace-docs:vkY31ug8IQ
+registry:
+  release:
+    name: devspace-registry
+    namespace: devspace-docs
+  user:
+    username: user-xNAsk
+    password: tY2XpapTMUjt
+cluster:
+  tillerNamespace: devspace-docs
+  useKubeConfig: true
+```
+
+The [.devspace/overwrite.yaml](#) is defined for every developer who wants to use a DevSpace for working on the respective project. This file should **never** be checked into a version control system. Therefore, the DevSpace CLI will automatically create a [.gitignore](#) file within [.devspace/](#) that tells git not to version this file.
+
+**Note: You can easily re-configure your DevSpace by running `devspace init -r`. Therefore, changing this file manually is highly discouraged.**
diff --git a/docs/docs/configuration/private.yaml.md b/docs/docs/configuration/private.yaml.md
diff --git a/docs/website/sidebars.json b/docs/website/sidebars.json
@@ -20,7 +20,7 @@
       "configuration/dockerfile",
       "configuration/chart",
       "configuration/config.yaml",
-      "configuration/private.yaml"
+      "configuration/overwrite.yaml"
     ],
     "Advanced": [
       "advanced/logs",
diff --git a/pkg/devspace/clients/kubectl/client.go b/pkg/devspace/clients/kubectl/client.go
@@ -10,7 +10,6 @@ import (
 	"sync"
 
 	"github.com/covexo/devspace/pkg/devspace/config/configutil"
-	"github.com/covexo/devspace/pkg/devspace/config/v1"
 	"github.com/covexo/devspace/pkg/util/log"
 	dockerterm "github.com/docker/docker/pkg/term"
 	k8sv1 "k8s.io/api/core/v1"
@@ -29,8 +28,6 @@ import (
 	"k8s.io/kubernetes/pkg/util/node"
 )
 
-var privateConfig = &v1.PrivateConfig{}
-
 //NewClient creates a new kubernetes client
 func NewClient() (*kubernetes.Clientset, error) {
 	config, err := GetClientConfig()
diff --git a/pkg/devspace/config/v1/schema.go b/pkg/devspace/config/v1/schema.go
@@ -73,19 +73,13 @@ type PortMapping struct {
 
 //SyncConfig defines the paths for a SyncFolder
 type SyncConfig struct {
-	ResourceType  *string            `yaml:"resourceType"`
-	LabelSelector map[string]*string `yaml:"labelSelector"`
-	LocalSubPath  *string            `yaml:"localSubPath"`
-	ContainerPath *string            `yaml:"containerPath"`
-	ExcludeRegex  []*string          `yaml:"excludeRegex"`
-}
-
-//PrivateConfig defines the private config of the users' computer
-type PrivateConfig struct {
-	Version  *string         `yaml:"version"`
-	Release  *Release        `yaml:"release"`
-	Tiller   *TillerConfig   `yaml:"tiller,omitempty"`
-	Registry *RegistryConfig `yaml:"registry"`
+	ResourceType         *string            `yaml:"resourceType"`
+	LabelSelector        map[string]*string `yaml:"labelSelector"`
+	LocalSubPath         *string            `yaml:"localSubPath"`
+	ContainerPath        *string            `yaml:"containerPath"`
+	ExcludePaths         []string           `yaml:"excludePaths"`
+	DownloadExcludePaths []string           `yaml:"downloadExcludePaths"`
+	UploadExcludePaths   []string           `yaml:"uploadExcludePaths"`
 }
 
 //Release defines running version of a project
diff --git a/pkg/devspace/kaniko/kaniko.go b/pkg/devspace/kaniko/kaniko.go
@@ -19,8 +19,6 @@ import (
 
 // BuildDockerfile builds a dockerfile in a kaniko build pod
 func BuildDockerfile(client *kubernetes.Clientset, buildNamespace, imageDestination, pullSecretName string, allowInsecureRegistry bool) error {
-	//registrySecretName := cmd.privateConfig.Registry.Release.Name + "-docker-registry-secret"
-	//registryHostname := cmd.privateConfig.Registry.Release.Name + "-docker-registry." + cmd.privateConfig.Registry.Release.Namespace + ".svc.cluster.local:5000"
 	workdir, err := os.Getwd()
 
 	if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -107,12 +107,12 @@ func (cmd ListCmd) RunListSync(cobraCmd cobra.Command, args []string) {`
`107`	`107`
`108`	`108`	`excludedPaths := ""`
`109`	`109`
`110`		`- for _, v := range value.ExcludeRegex {`
	`110`	`+ for _, v := range value.ExcludePaths {`
`111`	`111`	`if len(excludedPaths) > 0 {`
`112`	`112`	`excludedPaths += ", "`
`113`	`113`	`}`
`114`	`114`
`115`		`- excludedPaths += *v`
	`115`	`+ excludedPaths += v`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`syncPaths = append(syncPaths, []string{`