1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
|
%global _empty_manifest_terminate_build 0
Name: python-strato-skipper
Version: 2.0.0
Release: 1
Summary: Easily dockerize your Git repository
License: Apache-2
URL: http://github.com/Stratoscale/skipper
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f8/db/7266d94834cdeba863a248579915b7ce55a192d29787cd9e01f7aefc1680/strato-skipper-2.0.0.tar.gz
BuildArch: noarch
%description
[](https://github.com/Stratoscale/skipper/actions)
# Skipper
## Introduction
Use Skipper to build & test your project in an isolated environment, using Docker containers with pre-defined sane configuration.
Skipper allows you to execute makefile targets inside a container (or just run arbitrary commands). You can also use Skipper to build your development and production containers.
## Installation
It is recommended to install Skipper directly from PyPi:
```bash
sudo pip install strato-skipper
```
You can also install Skipper from source:
``` bash
git clone http://github.com/Stratoscale/skipper
sudo make install
```
Configure bash completion for skipper by sourcing the completion script in your ~/.bashrc file:
``` bash
echo 'source <(skipper completion)' >>~/.bashrc
```
## Python3 Environment
Skipper supports building and running in Python3 environment
Set your locale to UTF-8:
```bash
export LC_ALL="en_US.UTF-8"
export LANG="en_US.UTF-8"
```
## Usage
Skipper can serve as your primary tool for your daily development tasks:
* Use `skipper build` to build the images defined by the Dockerfiles in your repository. All the images will be automatically tagged with the *COMMIT_ID*.
* Use `skipper push` to publish your images.
* Use `skipper images` to list your images.
* Use `skipper rmi` to delete your images.
* Use `skipper make` to execute makefile targets inside a container.
* Use `skipper run` to run arbitrary commands inside a container.
* Use `skipper shell` to get an interactive shell inside a container.
### Global Options
```bash
-v, --verbose Increase verbosity
--registry URL of the docker registry
--build-container-image Image to use as build container
--build-container-tag Tag of the build container
--build-container-net Network to connect the build container (default: net=host)
--env-file Environment variables file/s to pass to the container
--help Show this message and exit.
```
### Build
As a convention, skipper infers the docker images from the Dockerfiles in the top directory of your repository. For example, assuming that there are 3 Dockerfile in the top directory of the repository:
```
Dockerfile.service1
Dockerfile.service2
Dockerfile.development
```
To build the image that corresponeds to `Dockerfile.service1`, run:
```bash
skipper build service1
```
In the same way you can build the image corresponded to `Dockerfile.development`:
```bash
skipper build development
```
You can also build mutliple images with single command:
```bash
skipper build development service2
```
A context path can be added to the build command, The build’s context is the files at a specified location PATH, the default is current directory:
```bash
skipper buid service1 --container-context /path/to/context/dir
```
If no image is specifed skipper will build all detected images:
```bash
skipper build
```
If you don't want to store all the Dockerfiles under the top directory of the project, you can specify the project's containers in skipper's config file (see below).
### Push
Once you've built the images of your repositories as described above. You can publish them by pushing them to the registry.
To push the `service1` image, run:
```bash
skipper --registry some-registry push service1
```
Note that the registry in this command must be the same registry used while building the image.
### Images
To list local images of your repository, run:
```bash
skipper images
```
In order to also list also images that were pushed to the registry, run:
```bash
skipper --registry some-registry images -r
```
### Rmi
To delete an image of your repository, run:
```bash
skipper rmi service1 <tag>
```
In order to delete the image from the registry, run:
```bash
skipper --registry some-registry rmi -r service1 <tag>
```
### Make
You can execute a Makefile target inside a container. This is good for keeping the development in an isolated environment, without installing development tools on the host. Once a development container is defined and built, it can be shared among the team member, assuring all of them use exactly thg same development environment.
Assuming your project has a Makefile with a `tests` target, you can run:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make tests
```
If your Makefile is not standard (i.e. `Makefile.arm32`) you can pass it to the make command:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make -f Makefile.arm32 tests
```
### Run
You can also run arbitrary commands inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
run gcc myprog.c -o myprog
```
### Shell
You can get a shell inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
shell
```
## Configuration File
Skipper allows you to define commonly used parameters in a configuration file `skipper.yaml` at the top directory of your repositry.
```yaml
registry: some-registry
build-container-image: development
build-container-tag: latest
container-context: /path/to/context/dir
make:
makefile: Makefile.arm32
containers:
service1: path/to/service1/dockerfile
service2: path/to/service2/dockerfile
env:
VAR: value
env_file: path/to/env_file.env
```
Using the above configuration file, we now can run a simplified version of the make command described above:
```bash
skipper make tests
```
### Published ports
For `shell`, `run` & `make` commands:
By default, when you run skipper on a linux machine it will use the host network and no mapping required.
For macos and windows machines where the host network is unsupported or for a custom network, you can publish a port and make it available to services outside of the container using the --publish or -p flag.
````
skipper make -p 123:123 tests
skipper make -p 123-130:123-130 tests
````
### Environment variables:
For `shell`, `run` & `make` commands:
You can use `-e` in order to pass environment variables to the container.
````
skipper make -e regex=test1 tests
````
Your configuration file can contain environment variables, Skipper will set the specified environment variables in the container.
````
env:
VAR: value
````
You can add an environment variables file (or multiple files) using `--env-file`.
This file should use the syntax <key>=value (which sets the variable to the given value) or <key>
(which takes the value from the local environment), and # for comments.
The variables defined in this file will be exported to the container.
Such file can look like this:
````
$ cat env_file.env
# This is a comment
KEY1=value1
KEY2=value2
KEY3
````
Skipper configuration file can include the environment variables file:
````
env_file:
- /path/to/env_file1.env
- /path/to/env_file2.env
````
### Variable substitution:
Skipper uses the variable values from the shell environment in which skipper is run.
It’s possible to use environment variables in your shell to populate values
For example, suppose the shell contains EXTERNAL_PORT=5000 and you supply this configuration:
````
env:
EXTERNAL_PORT: $EXTERNAL_PORT
````
When you run Skipper command with this configuration, Skipper looks for the EXTERNAL_PORT environment variable in the shell and substitutes its value in.In this example, Skipper resolves the `$EXTERNAL_PORT` to "5000" and will set EXTERNAL_PORT=5000 environment in the container.
If an environment variable is not set, Skipper substitutes with an empty string.
Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Extended shell-style features, such as `${VARIABLE-default}` and `${VARIABLE/foo/bar}`, are not supported.
You can use a `$$` (double-dollar sign) when your configuration needs a literal dollar sign. This also prevents Skipper from interpolating a value, so a `$$` allows you to refer to environment variables that you don’t want processed by Skipper.
````
env:
VAR: $$VAR_NOT_INTERPOLATED
````
### Shell Interpolation
Skipper supports evaluating shell commands inside its configuration file using `$(command)` notation.
e.g.
```yaml
env:
VAR: $(expr ${MY_NUMBER:-5} + 5)
volumes:
- $(which myprogram):/myprogram
```
### Volumes:
Skipper can bind-mount a host directory into the container.
you can add volumes in the configuration file:
````
volumes:
- /tmp:/tmp:rw
- ${HOME}/.netrc:/root/.netrc
- ${HOME}/.gocache:/tmp/.gocache
````
### Workdir:
Skipper default to the the project directory as the working directory for the `run`, `make` and `shell` commands,
you can override the workdir by specifying it in the configuration file:
````
workdir: /path/to/workdir
````
### Workspace:
Skipper default to the the project base directory (e.g. /path/to/project/../) as the workspace for the `run`, `make` and `shell` commands,
Note that the workspace directory is mounted by default.
you can override the workspace directory by specifying it in the configuration file
````
workdir: $PWD
````
### Skipper environment variables
Skipper sets environemnt variables to inform the user about the underline system:
CONTAINER_RUNTIME_COMMAND - The container conmmand used to run the skipper container. podman/docker
%package -n python3-strato-skipper
Summary: Easily dockerize your Git repository
Provides: python-strato-skipper
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-strato-skipper
[](https://github.com/Stratoscale/skipper/actions)
# Skipper
## Introduction
Use Skipper to build & test your project in an isolated environment, using Docker containers with pre-defined sane configuration.
Skipper allows you to execute makefile targets inside a container (or just run arbitrary commands). You can also use Skipper to build your development and production containers.
## Installation
It is recommended to install Skipper directly from PyPi:
```bash
sudo pip install strato-skipper
```
You can also install Skipper from source:
``` bash
git clone http://github.com/Stratoscale/skipper
sudo make install
```
Configure bash completion for skipper by sourcing the completion script in your ~/.bashrc file:
``` bash
echo 'source <(skipper completion)' >>~/.bashrc
```
## Python3 Environment
Skipper supports building and running in Python3 environment
Set your locale to UTF-8:
```bash
export LC_ALL="en_US.UTF-8"
export LANG="en_US.UTF-8"
```
## Usage
Skipper can serve as your primary tool for your daily development tasks:
* Use `skipper build` to build the images defined by the Dockerfiles in your repository. All the images will be automatically tagged with the *COMMIT_ID*.
* Use `skipper push` to publish your images.
* Use `skipper images` to list your images.
* Use `skipper rmi` to delete your images.
* Use `skipper make` to execute makefile targets inside a container.
* Use `skipper run` to run arbitrary commands inside a container.
* Use `skipper shell` to get an interactive shell inside a container.
### Global Options
```bash
-v, --verbose Increase verbosity
--registry URL of the docker registry
--build-container-image Image to use as build container
--build-container-tag Tag of the build container
--build-container-net Network to connect the build container (default: net=host)
--env-file Environment variables file/s to pass to the container
--help Show this message and exit.
```
### Build
As a convention, skipper infers the docker images from the Dockerfiles in the top directory of your repository. For example, assuming that there are 3 Dockerfile in the top directory of the repository:
```
Dockerfile.service1
Dockerfile.service2
Dockerfile.development
```
To build the image that corresponeds to `Dockerfile.service1`, run:
```bash
skipper build service1
```
In the same way you can build the image corresponded to `Dockerfile.development`:
```bash
skipper build development
```
You can also build mutliple images with single command:
```bash
skipper build development service2
```
A context path can be added to the build command, The build’s context is the files at a specified location PATH, the default is current directory:
```bash
skipper buid service1 --container-context /path/to/context/dir
```
If no image is specifed skipper will build all detected images:
```bash
skipper build
```
If you don't want to store all the Dockerfiles under the top directory of the project, you can specify the project's containers in skipper's config file (see below).
### Push
Once you've built the images of your repositories as described above. You can publish them by pushing them to the registry.
To push the `service1` image, run:
```bash
skipper --registry some-registry push service1
```
Note that the registry in this command must be the same registry used while building the image.
### Images
To list local images of your repository, run:
```bash
skipper images
```
In order to also list also images that were pushed to the registry, run:
```bash
skipper --registry some-registry images -r
```
### Rmi
To delete an image of your repository, run:
```bash
skipper rmi service1 <tag>
```
In order to delete the image from the registry, run:
```bash
skipper --registry some-registry rmi -r service1 <tag>
```
### Make
You can execute a Makefile target inside a container. This is good for keeping the development in an isolated environment, without installing development tools on the host. Once a development container is defined and built, it can be shared among the team member, assuring all of them use exactly thg same development environment.
Assuming your project has a Makefile with a `tests` target, you can run:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make tests
```
If your Makefile is not standard (i.e. `Makefile.arm32`) you can pass it to the make command:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make -f Makefile.arm32 tests
```
### Run
You can also run arbitrary commands inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
run gcc myprog.c -o myprog
```
### Shell
You can get a shell inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
shell
```
## Configuration File
Skipper allows you to define commonly used parameters in a configuration file `skipper.yaml` at the top directory of your repositry.
```yaml
registry: some-registry
build-container-image: development
build-container-tag: latest
container-context: /path/to/context/dir
make:
makefile: Makefile.arm32
containers:
service1: path/to/service1/dockerfile
service2: path/to/service2/dockerfile
env:
VAR: value
env_file: path/to/env_file.env
```
Using the above configuration file, we now can run a simplified version of the make command described above:
```bash
skipper make tests
```
### Published ports
For `shell`, `run` & `make` commands:
By default, when you run skipper on a linux machine it will use the host network and no mapping required.
For macos and windows machines where the host network is unsupported or for a custom network, you can publish a port and make it available to services outside of the container using the --publish or -p flag.
````
skipper make -p 123:123 tests
skipper make -p 123-130:123-130 tests
````
### Environment variables:
For `shell`, `run` & `make` commands:
You can use `-e` in order to pass environment variables to the container.
````
skipper make -e regex=test1 tests
````
Your configuration file can contain environment variables, Skipper will set the specified environment variables in the container.
````
env:
VAR: value
````
You can add an environment variables file (or multiple files) using `--env-file`.
This file should use the syntax <key>=value (which sets the variable to the given value) or <key>
(which takes the value from the local environment), and # for comments.
The variables defined in this file will be exported to the container.
Such file can look like this:
````
$ cat env_file.env
# This is a comment
KEY1=value1
KEY2=value2
KEY3
````
Skipper configuration file can include the environment variables file:
````
env_file:
- /path/to/env_file1.env
- /path/to/env_file2.env
````
### Variable substitution:
Skipper uses the variable values from the shell environment in which skipper is run.
It’s possible to use environment variables in your shell to populate values
For example, suppose the shell contains EXTERNAL_PORT=5000 and you supply this configuration:
````
env:
EXTERNAL_PORT: $EXTERNAL_PORT
````
When you run Skipper command with this configuration, Skipper looks for the EXTERNAL_PORT environment variable in the shell and substitutes its value in.In this example, Skipper resolves the `$EXTERNAL_PORT` to "5000" and will set EXTERNAL_PORT=5000 environment in the container.
If an environment variable is not set, Skipper substitutes with an empty string.
Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Extended shell-style features, such as `${VARIABLE-default}` and `${VARIABLE/foo/bar}`, are not supported.
You can use a `$$` (double-dollar sign) when your configuration needs a literal dollar sign. This also prevents Skipper from interpolating a value, so a `$$` allows you to refer to environment variables that you don’t want processed by Skipper.
````
env:
VAR: $$VAR_NOT_INTERPOLATED
````
### Shell Interpolation
Skipper supports evaluating shell commands inside its configuration file using `$(command)` notation.
e.g.
```yaml
env:
VAR: $(expr ${MY_NUMBER:-5} + 5)
volumes:
- $(which myprogram):/myprogram
```
### Volumes:
Skipper can bind-mount a host directory into the container.
you can add volumes in the configuration file:
````
volumes:
- /tmp:/tmp:rw
- ${HOME}/.netrc:/root/.netrc
- ${HOME}/.gocache:/tmp/.gocache
````
### Workdir:
Skipper default to the the project directory as the working directory for the `run`, `make` and `shell` commands,
you can override the workdir by specifying it in the configuration file:
````
workdir: /path/to/workdir
````
### Workspace:
Skipper default to the the project base directory (e.g. /path/to/project/../) as the workspace for the `run`, `make` and `shell` commands,
Note that the workspace directory is mounted by default.
you can override the workspace directory by specifying it in the configuration file
````
workdir: $PWD
````
### Skipper environment variables
Skipper sets environemnt variables to inform the user about the underline system:
CONTAINER_RUNTIME_COMMAND - The container conmmand used to run the skipper container. podman/docker
%package help
Summary: Development documents and examples for strato-skipper
Provides: python3-strato-skipper-doc
%description help
[](https://github.com/Stratoscale/skipper/actions)
# Skipper
## Introduction
Use Skipper to build & test your project in an isolated environment, using Docker containers with pre-defined sane configuration.
Skipper allows you to execute makefile targets inside a container (or just run arbitrary commands). You can also use Skipper to build your development and production containers.
## Installation
It is recommended to install Skipper directly from PyPi:
```bash
sudo pip install strato-skipper
```
You can also install Skipper from source:
``` bash
git clone http://github.com/Stratoscale/skipper
sudo make install
```
Configure bash completion for skipper by sourcing the completion script in your ~/.bashrc file:
``` bash
echo 'source <(skipper completion)' >>~/.bashrc
```
## Python3 Environment
Skipper supports building and running in Python3 environment
Set your locale to UTF-8:
```bash
export LC_ALL="en_US.UTF-8"
export LANG="en_US.UTF-8"
```
## Usage
Skipper can serve as your primary tool for your daily development tasks:
* Use `skipper build` to build the images defined by the Dockerfiles in your repository. All the images will be automatically tagged with the *COMMIT_ID*.
* Use `skipper push` to publish your images.
* Use `skipper images` to list your images.
* Use `skipper rmi` to delete your images.
* Use `skipper make` to execute makefile targets inside a container.
* Use `skipper run` to run arbitrary commands inside a container.
* Use `skipper shell` to get an interactive shell inside a container.
### Global Options
```bash
-v, --verbose Increase verbosity
--registry URL of the docker registry
--build-container-image Image to use as build container
--build-container-tag Tag of the build container
--build-container-net Network to connect the build container (default: net=host)
--env-file Environment variables file/s to pass to the container
--help Show this message and exit.
```
### Build
As a convention, skipper infers the docker images from the Dockerfiles in the top directory of your repository. For example, assuming that there are 3 Dockerfile in the top directory of the repository:
```
Dockerfile.service1
Dockerfile.service2
Dockerfile.development
```
To build the image that corresponeds to `Dockerfile.service1`, run:
```bash
skipper build service1
```
In the same way you can build the image corresponded to `Dockerfile.development`:
```bash
skipper build development
```
You can also build mutliple images with single command:
```bash
skipper build development service2
```
A context path can be added to the build command, The build’s context is the files at a specified location PATH, the default is current directory:
```bash
skipper buid service1 --container-context /path/to/context/dir
```
If no image is specifed skipper will build all detected images:
```bash
skipper build
```
If you don't want to store all the Dockerfiles under the top directory of the project, you can specify the project's containers in skipper's config file (see below).
### Push
Once you've built the images of your repositories as described above. You can publish them by pushing them to the registry.
To push the `service1` image, run:
```bash
skipper --registry some-registry push service1
```
Note that the registry in this command must be the same registry used while building the image.
### Images
To list local images of your repository, run:
```bash
skipper images
```
In order to also list also images that were pushed to the registry, run:
```bash
skipper --registry some-registry images -r
```
### Rmi
To delete an image of your repository, run:
```bash
skipper rmi service1 <tag>
```
In order to delete the image from the registry, run:
```bash
skipper --registry some-registry rmi -r service1 <tag>
```
### Make
You can execute a Makefile target inside a container. This is good for keeping the development in an isolated environment, without installing development tools on the host. Once a development container is defined and built, it can be shared among the team member, assuring all of them use exactly thg same development environment.
Assuming your project has a Makefile with a `tests` target, you can run:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make tests
```
If your Makefile is not standard (i.e. `Makefile.arm32`) you can pass it to the make command:
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
make -f Makefile.arm32 tests
```
### Run
You can also run arbitrary commands inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
run gcc myprog.c -o myprog
```
### Shell
You can get a shell inside your containers.
```bash
skipper --registry some-registry --build-container-image development --build-container-tag latest \
shell
```
## Configuration File
Skipper allows you to define commonly used parameters in a configuration file `skipper.yaml` at the top directory of your repositry.
```yaml
registry: some-registry
build-container-image: development
build-container-tag: latest
container-context: /path/to/context/dir
make:
makefile: Makefile.arm32
containers:
service1: path/to/service1/dockerfile
service2: path/to/service2/dockerfile
env:
VAR: value
env_file: path/to/env_file.env
```
Using the above configuration file, we now can run a simplified version of the make command described above:
```bash
skipper make tests
```
### Published ports
For `shell`, `run` & `make` commands:
By default, when you run skipper on a linux machine it will use the host network and no mapping required.
For macos and windows machines where the host network is unsupported or for a custom network, you can publish a port and make it available to services outside of the container using the --publish or -p flag.
````
skipper make -p 123:123 tests
skipper make -p 123-130:123-130 tests
````
### Environment variables:
For `shell`, `run` & `make` commands:
You can use `-e` in order to pass environment variables to the container.
````
skipper make -e regex=test1 tests
````
Your configuration file can contain environment variables, Skipper will set the specified environment variables in the container.
````
env:
VAR: value
````
You can add an environment variables file (or multiple files) using `--env-file`.
This file should use the syntax <key>=value (which sets the variable to the given value) or <key>
(which takes the value from the local environment), and # for comments.
The variables defined in this file will be exported to the container.
Such file can look like this:
````
$ cat env_file.env
# This is a comment
KEY1=value1
KEY2=value2
KEY3
````
Skipper configuration file can include the environment variables file:
````
env_file:
- /path/to/env_file1.env
- /path/to/env_file2.env
````
### Variable substitution:
Skipper uses the variable values from the shell environment in which skipper is run.
It’s possible to use environment variables in your shell to populate values
For example, suppose the shell contains EXTERNAL_PORT=5000 and you supply this configuration:
````
env:
EXTERNAL_PORT: $EXTERNAL_PORT
````
When you run Skipper command with this configuration, Skipper looks for the EXTERNAL_PORT environment variable in the shell and substitutes its value in.In this example, Skipper resolves the `$EXTERNAL_PORT` to "5000" and will set EXTERNAL_PORT=5000 environment in the container.
If an environment variable is not set, Skipper substitutes with an empty string.
Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Extended shell-style features, such as `${VARIABLE-default}` and `${VARIABLE/foo/bar}`, are not supported.
You can use a `$$` (double-dollar sign) when your configuration needs a literal dollar sign. This also prevents Skipper from interpolating a value, so a `$$` allows you to refer to environment variables that you don’t want processed by Skipper.
````
env:
VAR: $$VAR_NOT_INTERPOLATED
````
### Shell Interpolation
Skipper supports evaluating shell commands inside its configuration file using `$(command)` notation.
e.g.
```yaml
env:
VAR: $(expr ${MY_NUMBER:-5} + 5)
volumes:
- $(which myprogram):/myprogram
```
### Volumes:
Skipper can bind-mount a host directory into the container.
you can add volumes in the configuration file:
````
volumes:
- /tmp:/tmp:rw
- ${HOME}/.netrc:/root/.netrc
- ${HOME}/.gocache:/tmp/.gocache
````
### Workdir:
Skipper default to the the project directory as the working directory for the `run`, `make` and `shell` commands,
you can override the workdir by specifying it in the configuration file:
````
workdir: /path/to/workdir
````
### Workspace:
Skipper default to the the project base directory (e.g. /path/to/project/../) as the workspace for the `run`, `make` and `shell` commands,
Note that the workspace directory is mounted by default.
you can override the workspace directory by specifying it in the configuration file
````
workdir: $PWD
````
### Skipper environment variables
Skipper sets environemnt variables to inform the user about the underline system:
CONTAINER_RUNTIME_COMMAND - The container conmmand used to run the skipper container. podman/docker
%prep
%autosetup -n strato-skipper-2.0.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-strato-skipper -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.0-1
- Package Spec generated
|