1OC ADM MIGRATE(1)                  June 2016                 OC ADM MIGRATE(1)
2
3
4

NAME

6       oc adm migrate storage - Update the stored version of API objects
7
8
9

SYNOPSIS

11       oc adm migrate storage [OPTIONS]
12
13
14

DESCRIPTION

16       Migrate internal object storage via update
17
18
19       This  command invokes an update operation on every API object reachable
20       by the caller. This forces the server to write to the underlying  stor‐
21       age  if  the  object  representation  has  changed. Use this command to
22       ensure that the most recent storage changes have been  applied  to  all
23       objects (storage version, storage encoding, any newer object defaults).
24
25
26       To  operate  on  a  subset of resources, use the --include flag. If you
27       encounter errors during a  run  the  command  will  output  a  list  of
28       resources  that  received errors, which you can then re-run the command
29       on. You may also specify --from-key and --to-key to restrict the set of
30       resource  names  to  operate on (key is NAMESPACE/NAME for resources in
31       namespaces or NAME for cluster scoped resources). --from-key is  inclu‐
32       sive if specified, while --to-key is exclusive.
33
34
35       By  default,  events  are  not migrated since they expire within a very
36       short period of time. If you have significantly increased  the  expira‐
37       tion time of events, run a migration with --include=events
38
39
40       WARNING: This is a slow command and will put significant load on an API
41       server. It may also result in significant intra-cluster traffic.
42
43
44

OPTIONS

46       --all-namespaces=true
47           Migrate objects in all namespaces. Defaults to true.
48
49
50       --allow-missing-template-keys=true
51           If true, ignore any errors in templates when a field or map key  is
52       missing  in  the  template.  Only applies to golang and jsonpath output
53       formats.
54
55
56       --bandwidth=10
57           Average network bandwidth measured in megabits per second (Mbps) to
58       use during storage migration.  Zero means no limit.  This flag is alpha
59       and may change in the future.
60
61
62       -f, --filename=[]
63           Filename, directory, or URL to docker-compose.yml file to use
64
65
66       --from-key=""
67           If specified, only migrate items  with  a  key  (namespace/name  or
68       name) greater than or equal to this value
69
70
71       --include=[*]
72           Resource  types  to  migrate. Passing --filename will override this
73       flag.
74
75
76       --no-headers=false
77           When using the default or custom-column output format, don't  print
78       headers (default print headers).
79
80
81       --show-labels=false
82           When  printing,  show  all  labels as the last column (default hide
83       labels column)
84
85
86       --sort-by=""
87           If non-empty, sort list types using this field specification.   The
88       field  specification  is  expressed  as  a  JSONPath  expression  (e.g.
89       '{.metadata.name}'). The field in the API resource  specified  by  this
90       JSONPath expression must be an integer or a string.
91
92
93       --template=""
94           Template  string  or  path  to template file to use when -o=go-tem‐
95       plate, -o=go-template-file. The template format is golang  templates  [
96http://golang.org/pkg/text/template/#pkg-overview⟩].
97
98
99       --to-key=""
100           If  specified,  only  migrate  items  with a key (namespace/name or
101       name) less than this value
102
103
104

OPTIONS INHERITED FROM PARENT COMMANDS

106       --allow_verification_with_non_compliant_keys=false
107           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
108       non-compliant with RFC6962.
109
110
111       --alsologtostderr=false
112           log to standard error as well as files
113
114
115       --application_metrics_count_limit=100
116           Max number of application metrics to store (per container)
117
118
119       --as=""
120           Username to impersonate for the operation
121
122
123       --as-group=[]
124           Group  to  impersonate for the operation, this flag can be repeated
125       to specify multiple groups.
126
127
128       --azure-container-registry-config=""
129           Path to the file containing Azure container registry  configuration
130       information.
131
132
133       --boot_id_file="/proc/sys/kernel/random/boot_id"
134           Comma-separated  list  of files to check for boot-id. Use the first
135       one that exists.
136
137
138       --cache-dir="/builddir/.kube/http-cache"
139           Default HTTP cache directory
140
141
142       --certificate-authority=""
143           Path to a cert file for the certificate authority
144
145
146       --client-certificate=""
147           Path to a client certificate file for TLS
148
149
150       --client-key=""
151           Path to a client key file for TLS
152
153
154       --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
155           CIDRs opened in GCE firewall for LB traffic proxy  health checks
156
157
158       --cluster=""
159           The name of the kubeconfig cluster to use
160
161
162       --container_hints="/etc/cadvisor/container_hints.json"
163           location of the container hints file
164
165
166       --containerd="unix:///var/run/containerd.sock"
167           containerd endpoint
168
169
170       --context=""
171           The name of the kubeconfig context to use
172
173
174       --default-not-ready-toleration-seconds=300
175           Indicates    the    tolerationSeconds   of   the   toleration   for
176       notReady:NoExecute that is added by default to every pod that does  not
177       already have such a toleration.
178
179
180       --default-unreachable-toleration-seconds=300
181           Indicates  the  tolerationSeconds  of  the  toleration for unreach‐
182       able:NoExecute that is added by default to  every  pod  that  does  not
183       already have such a toleration.
184
185
186       --docker="unix:///var/run/docker.sock"
187           docker endpoint
188
189
190       --docker-tls=false
191           use TLS to connect to docker
192
193
194       --docker-tls-ca="ca.pem"
195           path to trusted CA
196
197
198       --docker-tls-cert="cert.pem"
199           path to client certificate
200
201
202       --docker-tls-key="key.pem"
203           path to private key
204
205
206       --docker_env_metadata_whitelist=""
207           a  comma-separated  list of environment variable keys that needs to
208       be collected for docker containers
209
210
211       --docker_only=false
212           Only report docker containers in addition to root stats
213
214
215       --docker_root="/var/lib/docker"
216           DEPRECATED: docker root is read from docker info (this is  a  fall‐
217       back, default: /var/lib/docker)
218
219
220       --enable_load_reader=false
221           Whether to enable cpu load reader
222
223
224       --event_storage_age_limit="default=24h"
225           Max length of time for which to store events (per type). Value is a
226       comma separated list of key values, where  the  keys  are  event  types
227       (e.g.: creation, oom) or "default" and the value is a duration. Default
228       is applied to all non-specified event types
229
230
231       --event_storage_event_limit="default=100000"
232           Max number of events to store (per type). Value is  a  comma  sepa‐
233       rated  list  of  key values, where the keys are event types (e.g.: cre‐
234       ation, oom) or "default" and  the  value  is  an  integer.  Default  is
235       applied to all non-specified event types
236
237
238       --global_housekeeping_interval=0
239           Interval between global housekeepings
240
241
242       --housekeeping_interval=0
243           Interval between container housekeepings
244
245
246       --httptest.serve=""
247           if non-empty, httptest.NewServer serves on this address and blocks
248
249
250       --insecure-skip-tls-verify=false
251           If true, the server's certificate will not be checked for validity.
252       This will make your HTTPS connections insecure
253
254
255       --kubeconfig=""
256           Path to the kubeconfig file to use for CLI requests.
257
258
259       --log-flush-frequency=0
260           Maximum number of seconds between log flushes
261
262
263       --log_backtrace_at=:0
264           when logging hits line file:N, emit a stack trace
265
266
267       --log_cadvisor_usage=false
268           Whether to log the usage of the cAdvisor container
269
270
271       --log_dir=""
272           If non-empty, write log files in this directory
273
274
275       --logtostderr=true
276           log to standard error instead of files
277
278
279       --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
280           Comma-separated list of files to  check  for  machine-id.  Use  the
281       first one that exists.
282
283
284       --match-server-version=false
285           Require server version to match client version
286
287
288       -n, --namespace=""
289           If present, the namespace scope for this CLI request
290
291
292       --request-timeout="0"
293           The  length  of  time  to  wait before giving up on a single server
294       request. Non-zero values should contain a corresponding time unit (e.g.
295       1s, 2m, 3h). A value of zero means don't timeout requests.
296
297
298       -s, --server=""
299           The address and port of the Kubernetes API server
300
301
302       --stderrthreshold=2
303           logs at or above this threshold go to stderr
304
305
306       --storage_driver_buffer_duration=0
307           Writes  in  the  storage driver will be buffered for this duration,
308       and committed to the non memory backends as a single transaction
309
310
311       --storage_driver_db="cadvisor"
312           database name
313
314
315       --storage_driver_host="localhost:8086"
316           database host:port
317
318
319       --storage_driver_password="root"
320           database password
321
322
323       --storage_driver_secure=false
324           use secure connection with database
325
326
327       --storage_driver_table="stats"
328           table name
329
330
331       --storage_driver_user="root"
332           database username
333
334
335       --token=""
336           Bearer token for authentication to the API server
337
338
339       --user=""
340           The name of the kubeconfig user to use
341
342
343       -v, --v=0
344           log level for V logs
345
346
347       --version=false
348           Print version information and quit
349
350
351       --vmodule=
352           comma-separated list of pattern=N settings for  file-filtered  log‐
353       ging
354
355
356

EXAMPLE

358                # Perform an update of all objects
359                oc adm migrate storage
360
361                # Only migrate pods
362                oc adm migrate storage --include=pods
363
364                # Only pods that are in namespaces starting with "bar"
365                oc adm migrate storage --include=pods --from-key=bar/ --to-key=bar/\xFF
366
367
368
369

SEE ALSO

371       oc-adm-migrate(1),
372
373
374

HISTORY

376       June 2016, Ported from the Kubernetes man-doc generator
377
378
379
380Openshift                  Openshift CLI User Manuals        OC ADM MIGRATE(1)
Impressum