Skip to content

Commit 2a38df7

Browse files
committed
Merge branch 'v6-docs-dev' of github.com:jschalz/devspace into v6-docs-dev
2 parents 3e48d43 + 98a495a commit 2a38df7

10 files changed

Lines changed: 47 additions & 37 deletions

File tree

docs/pages/configuration/deployments/helm/basics.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ deployments:
202202
name: bitnami/mysql
203203
```
204204
**Explanation:**
205-
Deploying the above example would roughly be equivalent to this command:
205+
Deploying the above example is roughly equivalent to this command:
206206
```bash
207207
helm install database bitnami/mysql
208208
```
@@ -229,7 +229,7 @@ deployments:
229229
version: "1.3.1"
230230
```
231231
**Explanation:**
232-
Deploying the above example would roughly be equivalent to this command:
232+
Deploying the above example is roughly equivalent to this command:
233233
```bash
234234
helm install database bitnami/mysql --version="1.3.1"
235235
```
@@ -247,7 +247,7 @@ deployments:
247247
repo: https://my-repo.tld/
248248
```
249249
**Explanation:**
250-
Deploying the above example would roughly be equivalent to this command:
250+
Deploying the above example is roughly equivalent to this command:
251251
```bash
252252
helm install database custom-chart --repo "https://my-repo.tld/"
253253
```
@@ -290,7 +290,7 @@ deployments:
290290
mysqlDatabase: app_database
291291
```
292292
**Explanation:**
293-
Deploying the above example would roughly be equivalent to this command:
293+
Deploying the above example is roughly equivalent to this command:
294294
```bash
295295
helm install database bitnami/mysql --set mysqlRootPassword="$MYSQL_ROOT_PASSWORD" --set mysqlUser="db_user" --set mysqlDatabase="app_database"
296296
```
@@ -323,7 +323,7 @@ deployments:
323323
- mysql/values.production.yaml
324324
```
325325
**Explanation:**
326-
Deploying the above example would roughly be equivalent to this command:
326+
Deploying the above example is roughly equivalent to this command:
327327
```bash
328328
helm install database bitnami/mysql -f mysql/values.yaml -f mysql/values.production.yaml
329329
```
@@ -350,7 +350,7 @@ deployments:
350350
```
351351

352352
**Explanation:**
353-
Deploying the above example would print the helm output and the `notes.txt` from the bitnami/mysql chart.
353+
Deploying the above example prints the helm output and the `notes.txt` from the bitnami/mysql chart.
354354

355355
### `templateArgs`
356356
The `templateArgs` specifies an array of arguments that will be passed by devspace additionally to the standard arguments to `helm template` during `devspace render`.

docs/pages/configuration/dev/basics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Kubernetes-based development can be useful in the following cases:
1919
- You want to test your application in a production-like environment
2020
- You want to debug issues that are hard to reproduce on your local machine
2121

22-
The development experience is very similar to using `docker-compose`. If you are already familiar on how to develop with `docker-compose`, DevSpace will behave very similar. One of the benefits of DevSpace versus `docker-compose` is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc., or in any remote Kubernetes cluster.
22+
The development experience is very similar to using `docker-compose`. If you are already familiar with how to develop with `docker-compose`, DevSpace will behave very similar. One of the benefits of DevSpace versus `docker-compose` is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc., or in any remote Kubernetes cluster.
2323

2424

2525
## Start Development Mode

docs/pages/configuration/dev/files/sync.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ dev:
9393
```
9494
**Explanation:**
9595
- Files in `logs/` and in `more/logs/` would not be synchronized at all.
96-
- Files in `node_modules/` would only be synchronized from the container to the local filesystem but not the other way around.
97-
- Files in `tmp/` would only be synchroniyed from the local to the container filesystem but not the other way around.
96+
- Files in `node_modules/` would only be synchronized from the container to the local filesystem, but not the other way around.
97+
- Files in `tmp/` would only be synchronized from the local to the container filesystem, but not the other way around.
9898

9999
#### Example: Only Sync Specific Folders
100100

@@ -388,8 +388,8 @@ The `initialSync` option expects a string with an initial sync strategy. The fol
388388

389389
#### • `mirrorRemote` mirrors the container files to the local filesystem:
390390

391-
1. deletes all files on the local filesystem that are not existing inside the container
392-
2. downloads all files which are existing inside the container but are missing on the local filesystem
391+
1. deletes all files on the local filesystem that do not exist inside the container
392+
2. downloads all files that exist inside the container, but are missing on the local filesystem
393393
3. resolves all file conflicts (different content on local filesystem than inside the container) by preferring the file within the container (i.e. all files on the local filesystem will be replaced if they are different than inside the container)
394394

395395
#### • `preferRemote` is like `mirrorRemote` but skips step 1.
@@ -434,8 +434,13 @@ dev:
434434
With this configuration, `devspace dev` performs the following tasks:
435435
- DevSpace would start port-forwarding and file synchronzation.
436436
- Initial sync is started automatically.
437+
<<<<<<< HEAD
437438
- The first sync config section synchronizes all files except files within `node_modules/`. This means that during initial sync, all remote files that do not already exist locally are deleted, and other files are updated to the most recent version.
438439
- The second sync config section only synchronizes files within `node_modules/`. Because of `initialSync: preferRemote`, DevSpace downloads all remote files which are not present on the local filesystem and overrides all local files which are different than the files within the container.
440+
=======
441+
- The first sync config section would synchronize all files except files within `node_modules/`. This means that during initial sync, all remote files that are not existing locally would be deleted and other files would be updated to the most recent version.
442+
- The second sync config section only synchronizes files within `node_modules/`. Because of `initialSync: preferRemote`, DevSpace downloads all remote files which are not present on the local filesystem and overrides all local files that are different than the files within the container.
443+
>>>>>>> 98a495ad09253bb70af2de316c8e06c60e1216d5
439444

440445
### `waitInitialSync`
441446
The `waitInitialSync` option expects a boolean which defines if DevSpace should wait until the initial sync process has terminated before opening the container terminal or the multi-container log streaming.
@@ -463,8 +468,13 @@ dev:
463468
waitInitialSync: false
464469
```
465470
**Explanation:**
471+
<<<<<<< HEAD
466472
With the configuration `devspace dev` the following actions will be taken:
467473
- DevSpace initiates port-forwarding and file synchronization.
474+
=======
475+
With the configuration `devspace dev` does the following:
476+
- DevSpace starts port-forwarding and file synchronization.
477+
>>>>>>> 98a495ad09253bb70af2de316c8e06c60e1216d5
468478
- Initial sync would be started automatically.
469479

470480
- Before the initial sync process is finished, DevSpace starts the log streaming.
@@ -542,7 +552,7 @@ Polling might increase CPU consumption of the container drastically, depending o
542552
:::
543553

544554
:::info
545-
If you are using a DevSpace config version below `v1beta10`, polling will be enabled by default, as it was the default syncing method in older DevSpace versions
555+
If you are using a DevSpace config version below `v1beta10`, polling is enabled by default, as it was the default syncing method in older DevSpace versions.
546556
:::
547557

548558
## Useful Commands
@@ -584,9 +594,9 @@ The algorithm roughly works like this:
584594

585595
<br/>
586596

587-
The `tar` command has to be present in the container otherwise `kubectl cp` does not work and the helper binary cannot be injected into the container.
597+
The `tar` command has to be present in the container, otherwise `kubectl cp` will not work and the helper binary cannot be injected into the container.
588598

589-
Other than that, no server-side component or special container privileges for code synchronization are required, as the sync algorithm runs completely client-only within DevSpace. The synchronization mechanism works with any container filesystem and no special binaries have to be installed into the containers. File watchers running within the containers like nodemon will also recognize changes made by the synchronization mechanism.
599+
No server-side component or special container privileges for code synchronization are required, since the sync algorithm runs completely client-only within DevSpace. The synchronization mechanism works with any container filesystem and no special binaries have to be installed into the containers. File watchers running within the containers like nodemon will also recognize changes made by the synchronization mechanism.
590600

591601
<br/>
592602

docs/pages/configuration/images/build-engines/custom.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ images:
2121
custom:
2222
skipImageArg: true
2323
command: |-
24-
# Also works on windows as this is executed in a golang shell
24+
# Also works on windows, as this is executed in a golang shell
2525
docker build -t ${runtime.images.backend.image}:${runtime.images.backend.tag} . -f custom/Dockerfile
2626
```
2727
**Explanation:**
2828
The image `backend` would be built using the command `docker build -t ${runtime.images.backend.image}:${runtime.images.backend.tag} . -f custom/Dockerfile"` while `${runtime.images.backend.image}` would be replaced with the `image` option (in this case: `john/appbackend`) and `${runtime.images.backend.tag}` would be replaced with the tag generated according to the [tagging schema](../../images/image-definition/tags.mdx).
2929

3030
### `onChange`
31-
The `onChange` option expects an array of strings which represent paths to files or folders that should be watched for changes. DevSpace uses these paths and the hash values it stores about these paths for evaluating if an image should be rebuilt or if the image building can be skipped because the context of the image has not changed.
31+
The `onChange` option expects an array of strings which represent paths to files or folders that should be watched for changes. DevSpace uses these paths, and the hash values it stores about these paths, to evaluate if an image should be rebuilt, or if the image building can be skipped because the context of the image has not changed.
3232

3333
:::info
3434
It is highly recommended to specify this option when using `custom` as build tool in order to speed up the build process.
@@ -52,4 +52,4 @@ images:
5252
- another/path/file.txt
5353
```
5454
**Explanation:**
55-
The image `backend` would be built using the command `./build --image "[IMAGE]:[TAG]"` and DevSpace would skip the build if none of the files within `some/path/` nor the file `another/path/file.txt` has changed since the last build.
55+
The image `backend` is built using the command `./build --image "[IMAGE]:[TAG]"`, and DevSpace skips the build if none of the files within `some/path/`, nor the file `another/path/file.txt`, has changed since the last build.

docs/pages/configuration/images/build-engines/kaniko.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ images:
4040
cache: false
4141
```
4242
**Explanation:**
43-
- The first image `backend` would be built using kaniko and make use of the build cache.
44-
- The second image `frontend` would be built using kaniko and **not** use the build cache.
43+
- The first image `backend` is built using kaniko and makes use of the build cache.
44+
- The second image `frontend` is built using kaniko and does **not** use the build cache.
4545

4646

4747
### `snapshotMode`
@@ -71,8 +71,8 @@ images:
7171
snapshotMode: time
7272
```
7373
**Explanation:**
74-
- The first image `backend` would be built using kaniko and creating full filesystem snapshots.
75-
- The second image `frontend` would be built using kaniko and calculate filesystem snapthots only based on `mtime`.
74+
- The first image `backend` is built using kaniko and creates full filesystem snapshots.
75+
- The second image `frontend` is built using kaniko and calculates filesystem snapshots only based on `mtime`.
7676

7777

7878
### `insecure`
@@ -96,7 +96,7 @@ images:
9696
insecure: false
9797
```
9898
**Explanation:**
99-
The image `backend` would be built using kaniko and pushing to the insecure registry `123.456.789.0:5000` would be allowed.
99+
The image `backend` is built using kaniko and pushes to the insecure registry `123.456.789.0:5000` if allowed.
100100

101101

102102
### `args`
@@ -122,7 +122,7 @@ images:
122122
- --verbosity=debug
123123
```
124124
**Explanation:**
125-
The image `backend` would be built using kaniko and the flags `--cache-dir=/tmp --verbosity=debug` would be set when running the build command within the kaniko pod used for image building.
125+
The image `backend` is built using kaniko and the flags `--cache-dir=/tmp --verbosity=debug` are set when running the build command within the kaniko pod used for image building.
126126

127127

128128
### `command`
@@ -283,10 +283,10 @@ images:
283283
pullSecret: custom-pull-secret
284284
```
285285
**Explanation:**
286-
The image `backend` would be built using kaniko and kaniko would use the Kubernete secret `custom-pull-secret` to pull images from registries that require authentication.
286+
The image `backend` is built using kaniko. Kaniko uses the Kubernete secret, `custom-pull-secret`, to pull images from registries that require authentication.
287287

288288
:::tip Creating Pull Secrets using `pullSecrets`
289-
If you use the `pullSecret` option, you have to create the secret before DevSpace tries to build your images. You can automate this by [using the pullSecrets feature](../../pullSecrets/basics.mdx) as shown in this example:
289+
If you use the `pullSecret` option, you must create the secret before DevSpace tries to build your images. You can automate this by [using the pullSecrets feature](../../pullSecrets/basics.mdx) as shown in this example:
290290
```yaml
291291
pullSecrets:
292292
- registry: my-registry.com:5000
@@ -349,7 +349,7 @@ images:
349349
path: token.json
350350
```
351351
**Explanation:**
352-
The above configuration would create a kaniko container which mounts the following volumes:
352+
The above configuration creates a kaniko container which mounts the following volumes:
353353
- All keys within the ConfigMap `my-configmap` will be mounted as files within the folder `/some/configmap/dir`. The filenames will be the keys within the ConfigMap.
354354
- The key `aws-token` within the Secret `my-secret` will be mounted as the file `/some/secret/dir/token.json`.
355355

@@ -396,7 +396,7 @@ images:
396396
namespace: build-namespace
397397
```
398398
**Explanation:**
399-
The image `backend` would be built using kaniko and the build pod started to run the kaniko build process would be created within the namespace `build-namespace` within the cluster that the current kube-context points to.
399+
The image `backend` is built using kaniko. The build pod starts to run the kaniko build process and creates the namespace `build-namespace` within the cluster that the current kube-context points to.
400400

401401
### `serviceAccount`
402402

docs/pages/configuration/images/build-settings/network.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ images:
1515
network: host
1616
```
1717
**Explanation:**
18-
The image `backend` would be built using `docker` and `docker build` would be called using the `--network=host` flag.
18+
The image `backend` is built using `docker`, and `docker build` is called using the `--network=host` flag.

docs/pages/configuration/images/image-definition/dockerfile.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ images:
2727
context: frontend/
2828
```
2929
**Explanation:**
30-
- The first image would be built using the Dockerfile in `./Dockerfile` and the context path `./`.
31-
- The second image would be built using the Dockerfile in `./frontend/Dockerfile` and the context path `./frontend/`.
32-
- Switching the `context` for image `frontend` would assure that a statement like `ADD file.txt` or `COPY file.txt .` in `./frontend/Dockerfile` would use the local file `./frontend/file.txt` instead of `./file.txt`.
30+
- The first image is built using the Dockerfile in `./Dockerfile` and the context path `./`.
31+
- The second image is built using the Dockerfile in `./frontend/Dockerfile` and the context path `./frontend/`.
32+
- Switching the `context` for image `frontend` assures that a statement like `ADD file.txt` or `COPY file.txt .` in `./frontend/Dockerfile` uses the local file `./frontend/file.txt` instead of `./file.txt`.
3333
- In this example, it would probably be useful to have a `./.dockerignore` file which ignores the `frontend/` folder when building the first image called `backend`.
3434

3535
:::note

docs/pages/configuration/images/image-definition/tags.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ images:
2020
```
2121
2222
:::info Unique Tags For Development
23-
**Make sure tags are unique** when defining a custom tagging schema for development. Unique tags ensure that your application gets started with the newly built image instead of using an older, cached version. Therefore, it is highly recommended for non-production tags to either use `#` placeholders or `devspace.timestamp` as a suffix in your tagging schema (see [example below](#example-custom-tagging-schema)).
23+
**Make sure tags are unique** when defining a custom tagging schema for development. Unique tags ensure your application starts with the newly built image instead of using an older, cached version. Therefore, it is highly recommended for non-production tags to either use `#` placeholders or `devspace.timestamp` as a suffix in your tagging schema (see [example below](#example-custom-tagging-schema)).
2424
:::
2525

2626
#### Default Value For `tag`
@@ -39,7 +39,7 @@ images:
3939
- dev-backend-${devspace.git.commit}-#####
4040
```
4141
**Explanation:**
42-
The above example would always use the tag `latest` and additionaly generate random tags which could look like this one: `dev-backend-b6caf8a-Jak9i`. This example tag consists of the following substrings defined by the tagging schema:
42+
The above example always uses the tag `latest`, while generating random tags which could look like this one: `dev-backend-b6caf8a-Jak9i`. This example tag consists of the following substrings defined by the tagging schema:
4343
- `dev-` static string
4444
- `-backend-` static string
4545
- `b6caf8a` latest git commit hash on current local branch

docs/pages/guides/ci-cd-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ DevSpace is configured to deploy and terminate when you run `devspace deploy`. I
4444
```bash
4545
devspace deploy --wait --timeout=120
4646
```
47-
The above command will wait until the desired number of pods is created for all ReplicaSets and until none of the pods are failing anymore. If this is not achieved within the number of seconds specified in `--timeout`, DevSpace will exit with a fatal error.
47+
The above command will wait until the desired number of pods is created for all ReplicaSets, and until none of the pods are failing. If this is not achieved within the number of seconds specified in `--timeout`, DevSpace will exit with a fatal error.
4848

4949
### Separate Build & Deploy
5050
DevSpace allows you to split up the build and deployment process into two separate commands:

0 commit comments

Comments
 (0)