Skip to content

Commit e1d27b9

Browse files
FabianKrammFabianKramm
authored
Merge pull request #2393 from lizardruss/main
Local registry documentation
2 parents 2284075 + 9f5c92b commit e1d27b9

21 files changed

Lines changed: 510 additions & 13 deletions

File tree

‎devspace-schema.json‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,6 +1201,54 @@
12011201
"type": "object",
12021202
"description": "KubectlConfig defines the specific kubectl options used during deployment"
12031203
},
1204+
"LocalRegistryConfig": {
1205+
"properties": {
1206+
"enabled": {
1207+
"type": "boolean",
1208+
"description": "Enabled enables the local registry for pushing images.\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\nWhen `true` the local registry will always be used.\nWhen `false` the local registry will never be used."
1209+
},
1210+
"namespace": {
1211+
"type": "string",
1212+
"description": "Namespace where the local registry is deployed. Default is the current context's namespace"
1213+
},
1214+
"name": {
1215+
"type": "string",
1216+
"description": "Name of the deployment and service of the local registry. Default is `registry`"
1217+
},
1218+
"image": {
1219+
"type": "string",
1220+
"description": "Image of the local registry. Default is `registry:2.8.1`"
1221+
},
1222+
"port": {
1223+
"type": "integer",
1224+
"description": "Port that the registry image listens on. Default is `5000`"
1225+
},
1226+
"persistence": {
1227+
"$ref": "#/$defs/LocalRegistryPersistence",
1228+
"description": "Persistence settings for the local registry"
1229+
}
1230+
},
1231+
"type": "object",
1232+
"description": "LocalRegistryConfig holds the configuration of the local image registry"
1233+
},
1234+
"LocalRegistryPersistence": {
1235+
"properties": {
1236+
"enabled": {
1237+
"type": "boolean",
1238+
"description": "Enable enables persistence for the local registry"
1239+
},
1240+
"size": {
1241+
"type": "string",
1242+
"description": "Size of the persistent volume for local docker registry storage. Default is `5Gi`"
1243+
},
1244+
"storageClassName": {
1245+
"type": "string",
1246+
"description": "StorageClassName of the persistent volume. Default is your cluster's configured default storage class"
1247+
}
1248+
},
1249+
"type": "object",
1250+
"description": "LocalRegistryPersistence configures persistence settings for the local registry"
1251+
},
12041252
"Logs": {
12051253
"properties": {
12061254
"enabled": {
@@ -2084,6 +2132,10 @@
20842132
"require": {
20852133
"$ref": "#/$defs/RequireConfig",
20862134
"description": "Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not\nfulfilled, DevSpace will fail."
2135+
},
2136+
"localRegistry": {
2137+
"$ref": "#/$defs/LocalRegistryConfig",
2138+
"description": "LocalRegistry specifies the configuration for a local image registry"
20872139
}
20882140
},
20892141
"type": "object",

‎docs/pages/cli/devspace_cleanup_local-registry.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "devspace cleanup local-registry --help"
3+
sidebar_label: devspace cleanup local-registry
4+
---
5+
6+
7+
Deletes the local image registry
8+
9+
## Synopsis
10+
11+
12+
```
13+
devspace cleanup local-registry [flags]
14+
```
15+
16+
```
17+
#######################################################
18+
######### devspace cleanup local-registry #############
19+
#######################################################
20+
Deletes the local image registry
21+
#######################################################
22+
```
23+
24+
25+
## Flags
26+
27+
```
28+
-h, --help help for local-registry
29+
```
30+
31+
32+
## Global & Inherited Flags
33+
34+
```
35+
--debug Prints the stack trace if an error occurs
36+
--disable-profile-activation If true will ignore all profile activations
37+
--inactivity-timeout int Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
38+
--kube-context string The kubernetes context to use
39+
--kubeconfig string The kubeconfig path to use
40+
-n, --namespace string The kubernetes namespace to use
41+
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
42+
--override-name string If specified will override the devspace.yaml name
43+
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
44+
--silent Run in silent mode and prevents any devspace log output except panics & fatals
45+
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
46+
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
47+
```
48+

‎docs/pages/configuration/_partials/v2beta1/localRegistry.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
import PartialLocalRegistryreference from "./localRegistry_reference.mdx"
3+
4+
5+
<details className="config-field" data-expandable="true" open>
6+
<summary>
7+
8+
## `localRegistry` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry}
9+
10+
LocalRegistry specifies the configuration for a local image registry
11+
12+
</summary>
13+
14+
<PartialLocalRegistryreference />
15+
16+
17+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/enabled.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `enabled` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#localRegistry-enabled}
6+
7+
Enabled enables the local registry for pushing images.
8+
When unset the local registry will be used as a fallback if there are no push permissions for the registry.
9+
When `true` the local registry will always be used.
10+
When `false` the local registry will never be used.
11+
12+
</summary>
13+
14+
15+
16+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/image.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `image` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry-image}
6+
7+
Image of the local registry. Default is `registry:2.8.1`
8+
9+
</summary>
10+
11+
12+
13+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/name.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `name` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry-name}
6+
7+
Name of the deployment and service of the local registry. Default is `registry`
8+
9+
</summary>
10+
11+
12+
13+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/namespace.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `namespace` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry-namespace}
6+
7+
Namespace where the local registry is deployed. Default is the current context's namespace
8+
9+
</summary>
10+
11+
12+
13+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/persistence.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
import PartialPersistencereference from "./persistence_reference.mdx"
3+
4+
5+
<details className="config-field" data-expandable="true" open>
6+
<summary>
7+
8+
### `persistence` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry-persistence}
9+
10+
Persistence settings for the local registry
11+
12+
</summary>
13+
14+
<PartialPersistencereference />
15+
16+
17+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/persistence/enabled.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
#### `enabled` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#localRegistry-persistence-enabled}
6+
7+
Enable enables persistence for the local registry
8+
9+
</summary>
10+
11+
12+
13+
</details>

‎docs/pages/configuration/_partials/v2beta1/localRegistry/persistence/size.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
#### `size` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#localRegistry-persistence-size}
6+
7+
Size of the persistent volume for local docker registry storage. Default is `5Gi`
8+
9+
</summary>
10+
11+
12+
13+
</details>

0 commit comments

Comments
 (0)