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

NAME

6       oc rsync - Copy files between local filesystem and a pod
7
8
9

SYNOPSIS

11       oc rsync [OPTIONS]
12
13
14

DESCRIPTION

16       Copy local files to or from a pod container
17
18
19       This  command  will  copy local files to or from a remote container. It
20       only copies the changed files using the rsync command from your OS.  To
21       ensure optimum performance, install rsync locally. In UNIX systems, use
22       your   package   manager.   In   Windows,    install    cwRsync    from
23https://www.itefix.net/cwrsync⟩.
24
25
26       If  no  container  is specified, the first container of the pod is used
27       for the copy.
28
29
30       The  following  flags  are  passed  to  rsync  by  default:   --archive
31       --no-owner --no-group --omit-dir-times --numeric-ids
32
33
34

OPTIONS

36       --compress=false
37           compress file data during the transfer
38
39
40       -c, --container=""
41           Container within the pod
42
43
44       --delete=false
45           If true, delete files not present in source
46
47
48       --exclude=[]
49           If true, exclude files matching specified pattern
50
51
52       --include=[]
53           If true, include files matching specified pattern
54
55
56       --no-perms=false
57           If true, do not transfer permissions
58
59
60       --progress=false
61           If true, show progress during transfer
62
63
64       -q, --quiet=false
65           Suppress non-error messages
66
67
68       --strategy=""
69           Specify which strategy to use for copy: rsync, rsync-daemon, or tar
70
71
72       -w, --watch=false
73           Watch directory for changes and resync automatically
74
75
76

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

326                # Synchronize a local directory with a pod directory
327                oc rsync ./local/dir/ POD:/remote/dir
328
329                # Synchronize a pod directory with a local directory
330                oc rsync POD:/remote/dir/ ./local/dir
331
332
333
334

SEE ALSO

336       oc(1),
337
338
339

HISTORY

341       June 2016, Ported from the Kubernetes man-doc generator
342
343
344
345Openshift                  Openshift CLI User Manuals                    OC(1)
Impressum