Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
Bastien Gounon
xcache-flusher
Commits
7ed7e267
Commit
7ed7e267
authored
Oct 16, 2020
by
Bastien Gounon
🐗
Browse files
update README
parent
8fcde938
Pipeline
#87236
passed with stage
in 4 minutes and 29 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
36 additions
and
4 deletions
+36
-4
README.md
README.md
+36
-4
No files found.
README.md
View file @
7ed7e267
# Server side
## Server side
### Using binary executable
Download the binary, make it executable and provide parameters
\
e
xample
:
`./xcache-flusher -port 8080 -cachedir /tmp/testdir -token mysecretpassword`
\
h
elp available with
`./xcache-flusher -h`
E
xample:
`./xcache-flusher -port 8080 -cachedir /tmp/testdir
01,/tmp/testdir02
-token mysecretpassword`
\
H
elp available with
`./xcache-flusher -h`
Server will listen on port 8080
# Client side
### Using Docker container
Download the image:
\
`docker pull gitlab-registry.in2p3.fr/bastien.gounon/xcache-flusher`
\
When running you must specify environment variables for configuration:
-
`FLUSHER_DIR`
: comma-separated list of directories to flush
-
(opt)
`FLUSHER_PORT`
: port on which to listen, default 8080. Using default and redirecting a different host port via Docker is preferrable.
-
(opt)
`FLUSHER_TOKEN`
: string used to authenticate client requests
\
Example:
```
docker run -p 54321:8080 --env FLUSHER_DIR=/xcache/data,/xcache/metadata --env FLUSHER_TOKEN=mysecretpassword -v /path/to/data:/xcache gitlab-registry.in2p3.fr/bastien.gounon/xcache-flusher
```
Docker-compose example:
```
version: '3'
services:
xcache-flusher:
image: gitlab-registry.in2p3.fr/bastien.gounon/xcache-flusher
restart: always
volumes:
- /tmp/xcache:/xcache
environment:
- FLUSHER_DIR=/xcache/data,/xcache/metadata
- FLUSHER_TOKEN=mysecretpassword
ports:
- 54321:8080
```
## Client side
Client just needs to call the DELETE HTTP operation on the server URL with method
`flush`
. Optionnally provide authentication token in the URL.
\
example:
*
with authentication:
`curl -X DELETE http://127.0.0.1:8080/flush\?token\=mysecretpassword`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment