You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/azdata/reference/reference-azdata-arc-dc-config.md
+8-46Lines changed: 8 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc config commands.
5
5
author: MikeRayMSFT
6
6
ms.author: mikeray
7
7
ms.reviewer: seanw
8
-
ms.date: 09/22/2020
8
+
ms.date: 04/06/2021
9
9
ms.topic: reference
10
10
ms.prod: sql
11
11
ms.technology: big-data-cluster
@@ -30,10 +30,7 @@ The following article provides reference for the **sql** commands in the **azdat
30
30
## azdata arc dc config init
31
31
Initializes a data controller configuration profile that can be used with control create. The specific source of the configuration profile can be specified in the arguments.
32
32
```bash
33
-
azdata arc dc config init [--path -p]
34
-
[--source -s]
35
-
36
-
[--force -f]
33
+
azdata arc dc config init
37
34
```
38
35
### Examples
39
36
Guided data controller config init experience - you will receive prompts for needed values.
@@ -42,15 +39,8 @@ azdata arc dc config init
42
39
```
43
40
arc dc config init with arguments, creates a configuration profile of aks-dev-test in ./custom.
44
41
```bash
45
-
azdata arc dc config init --source aks-dev-test --path custom
42
+
azdata arc dc config init --source azure-arc-kubeadm --path custom
46
43
```
47
-
### Optional Parameters
48
-
#### `--path -p`
49
-
File path of where you would like the config profile placed, defaults to <cwd>/custom.
Increase logging verbosity to show all debug logs.
@@ -94,19 +80,13 @@ Increase logging verbosity. Use --debug for full debug logs.
94
80
## azdata arc dc config add
95
81
Adds the value at the json path in the config file. All examples below are given in Bash. If using another command line, please be aware that you may need to escapequotations appropriately. Alternatively, you may use the patch file functionality.
96
82
```bash
97
-
azdata arc dc config add --path -p
98
-
--json-values -j
83
+
azdata arc dc config add
99
84
```
100
85
### Examples
101
86
Ex 1 - Add data controller storage.
102
87
```bash
103
88
azdata arc dc config add --path custom/control.json --json-values "spec.storage={"accessMode":"ReadWriteOnce","className":"managed-premium","size":"10Gi"}"
104
89
```
105
-
### Required Parameters
106
-
#### `--path -p`
107
-
Data controller config file path of the config you would like to set, i.e. custom/control.json
108
-
#### `--json-values -j`
109
-
A key value pair list of json paths to values: key1.subkey1=value1,key2.subkey2=value2. You may provide inline json values such as: key='{"kind":"cluster","name":"test-cluster"}' or provide a file path, such as key=./values.json. Add does NOT support conditionals. If the inline value you are providing is a key value pair itself with "=" and "," please escape those characters. For example, key1="key2\=val2\,key3\=val3". Please see http://jsonpatch.com/ for examples of how your path should look. If you would like to access an array, you must do so by indicating the index, such as key.0=value
110
90
### Global Arguments
111
91
#### `--debug`
112
92
Increase logging verbosity to show all debug logs.
@@ -121,19 +101,13 @@ Increase logging verbosity. Use --debug for full debug logs.
121
101
## azdata arc dc config remove
122
102
Removes the value at the json path in the config file. All examples below are given in Bash. If using another command line, please be aware that you may need to escapequotations appropriately. Alternatively, you may use the patch file functionality.
123
103
```bash
124
-
azdata arc dc config remove --path -p
125
-
--json-path -j
104
+
azdata arc dc config remove
126
105
```
127
106
### Examples
128
107
Ex 1 - Remove data controller storage.
129
108
```bash
130
109
azdata arc dc config remove --path custom/control.json --json-path ".spec.storage"
131
110
```
132
-
### Required Parameters
133
-
#### `--path -p`
134
-
Data controller config file path of the config you would like to set, i.e. custom/control.json
135
-
#### `--json-path -j`
136
-
A list of json paths based on the jsonpatch library that indicates which values you would like removed, such as: key1.subkey1,key2.subkey2. Remove does NOT support conditionals. Please see http://jsonpatch.com/ for examples of how your path should look. If you would like to access an array, you must do so by indicating the index, such as key.0=value
137
111
### Global Arguments
138
112
#### `--debug`
139
113
Increase logging verbosity to show all debug logs.
@@ -148,8 +122,7 @@ Increase logging verbosity. Use --debug for full debug logs.
148
122
## azdata arc dc config replace
149
123
Replaces the value at the json path in the config file. All examplesbelow are given in Bash. If using another command line, please be aware that you may need to escapequotations appropriately. Alternatively, you may use the patch file functionality.
150
124
```bash
151
-
azdata arc dc config replace --path -p
152
-
--json-values -j
125
+
azdata arc dc config replace
153
126
```
154
127
### Examples
155
128
Ex 1 - Replace the port of a single endpoint (Data Controller Endpoint).
@@ -160,11 +133,6 @@ Ex 2 - Replace data controller storage.
160
133
```bash
161
134
azdata arc dc config replace --path custom/control.json --json-values "spec.storage={"accessMode":"ReadWriteOnce","className":"managed-premium","size":"10Gi"}"
162
135
```
163
-
### Required Parameters
164
-
#### `--path -p`
165
-
Data controller config file path of the config you would like to set, i.e. custom/control.json
166
-
#### `--json-values -j`
167
-
A key value pair list of json paths to values: key1.subkey1=value1,key2.subkey2=value2. You may provide inline json values such as: key='{"kind":"cluster","name":"test-cluster"}' or provide a file path, such as key=./values.json. Replace supports conditionals through the jsonpath library. To use this, start your path with a $. This will allow you to do a conditional such as -j $.key1.key2[?(@.key3=="someValue"].key4=value. If the inline value you are providing is a key value pair itself with "=" and "," please escape those characters. For example, key1="key2\=val2\,key3\=val3". You may see examples below. For additional help, please see: https://jsonpath.com/
168
136
### Global Arguments
169
137
#### `--debug`
170
138
Increase logging verbosity to show all debug logs.
@@ -179,8 +147,7 @@ Increase logging verbosity. Use --debug for full debug logs.
179
147
## azdata arc dc config patch
180
148
Patches the config file according to the given patch file. Please consult http://jsonpatch.com/ for a better understanding of how the paths should be composed. The replace operation can use conditionals in its path due to the jsonpath library https://jsonpath.com/. All patch json files must start with a key of "patch" that has an array of patches with their corresponding op (add, replace, remove), path, and value. The "remove" op does not require a value, just a path. Please see the examples below.
181
149
```bash
182
-
azdata arc dc config patch --path
183
-
--patch-file -p
150
+
azdata arc dc config patch
184
151
```
185
152
### Examples
186
153
Ex 1 - Replace the port of a single endpoint (Data Controller Endpoint) with patch file.
Data controller config file path of the config you would like to set, i.e. custom/control.json
203
-
#### `--patch-file -p`
204
-
Path to a patch json file that is based off the jsonpatch library: http://jsonpatch.com/. You must start your patch json file with a key called "patch", whose value is an array of patch operations you intend to make. For the path of a patch operation, you may use dot notation, such as key1.key2 for most operations. If you would like to do a replace operation, and you are replacing a value in an array that requires a conditional, please use the jsonpath notation by beginning your path with a $. This will allow you to do a conditional such as $.key1.key2[?(@.key3=="someValue"].key4. Please see the examples below. For additional help with conditionals, please see: https://jsonpath.com/.
205
167
### Global Arguments
206
168
#### `--debug`
207
169
Increase logging verbosity to show all debug logs.
Copy file name to clipboardExpand all lines: docs/azdata/reference/reference-azdata-arc-dc-debug.md
+3-51Lines changed: 3 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc debug commands.
5
5
author: MikeRayMSFT
6
6
ms.author: mikeray
7
7
ms.reviewer: seanw
8
-
ms.date: 09/22/2020
8
+
ms.date: 04/06/2021
9
9
ms.topic: reference
10
10
ms.prod: sql
11
11
ms.technology: big-data-cluster
@@ -26,43 +26,8 @@ The following article provides reference for the **sql** commands in the **azdat
26
26
## azdata arc dc debug copy-logs
27
27
Copy the debug logs from the data controller - Kubernetes configuration is required on your system.
28
28
```bash
29
-
azdata arc dc debug copy-logs --namespace -ns
30
-
[--container -c]
31
-
32
-
[--target-folder -d]
33
-
34
-
[--pod]
35
-
36
-
[--resource-kind -rk]
37
-
38
-
[--resource-name -rn]
39
-
40
-
[--timeout -t]
41
-
42
-
[--skip-compress -sc]
43
-
44
-
[--exclude-dumps -ed]
29
+
azdata arc dc debug copy-logs
45
30
```
46
-
### Required Parameters
47
-
#### `--namespace -ns`
48
-
Kubernetes namespace of the data controller.
49
-
### Optional Parameters
50
-
#### `--container -c`
51
-
Copy the logs for the containers with similar name, Optional, by default copies logs for all containers. Cannot be specified multiple times. If specified multiple times, last one will be used
52
-
#### `--target-folder -d`
53
-
Target folder path to copy logs to. Optional, by default creates the result in the local folder. Cannot be specified multiple times. If specified multiple times, last one will be used
54
-
#### `--pod`
55
-
Copy the logs for the pods with similar name. Optional, by default copies logs for all pods. Cannot be specified multiple times. If specified multiple times, last one will be used
56
-
#### `--resource-kind -rk`
57
-
Copy the logs for the resource of a particular kind. Cannot specified multiple times. If specified multiple times, last one will be used. If specified, --resource-name should also be specified to identify the resource.
58
-
#### `--resource-name -rn`
59
-
Copy the logs for the resource of the specified name. Cannot be specified multiple times. If specified multiple times, last one will be used. If specified, --resource-kind should also be specified to identify the resource.
60
-
#### `--timeout -t`
61
-
The number of seconds to wait for the command to complete. The default value is 0 which is unlimited
62
-
#### `--skip-compress -sc`
63
-
Whether or not to skip compressing the result folder. The default value is False which compresses the result folder.
64
-
#### `--exclude-dumps -ed`
65
-
Whether or not to exclude dumps from result folder. The default value is False which includes dumps.
66
31
### Global Arguments
67
32
#### `--debug`
68
33
Increase logging verbosity to show all debug logs.
@@ -77,21 +42,8 @@ Increase logging verbosity. Use --debug for full debug logs.
77
42
## azdata arc dc debug dump
78
43
Trigger memory dump and copy it out from container - Kubernetes configuration is required on your system.
79
44
```bash
80
-
azdata arc dc debug dump --namespace -ns
81
-
[--container -c]
82
-
83
-
[--target-folder -d]
45
+
azdata arc dc debug dump
84
46
```
85
-
### Required Parameters
86
-
#### `--namespace -ns`
87
-
Kubernetes namespace of the data controller.
88
-
### Optional Parameters
89
-
#### `--container -c`
90
-
The target container to be triggered for dumping the running processes.
91
-
`controller`
92
-
#### `--target-folder -d`
93
-
Target folder to copy the dump out.
94
-
`./output/dump`
95
47
### Global Arguments
96
48
#### `--debug`
97
49
Increase logging verbosity to show all debug logs.
0 commit comments