Skip to content

Latest commit

 

History

History
77 lines (63 loc) · 2.35 KB

Capstanignore.md

File metadata and controls

77 lines (63 loc) · 2.35 KB
Raw

.capstanignore

When composing a unikernel Capstan uploads all files from current directory to the unikernel. For simple demo applications this is totally acceptable, but sooner or later you'll want to prevent Capstan from uploading some subfolders (e.g. .idea/) and that's where .capstanignore comes in.

Ignored by default

There are some folders that are ignored (i.e. not copied to the unikernel that you're composing) even if you don't provide your own .capstanignore file:

/meta
/mpm-pkg
/.git

These folders do not get uploaded to the unikernel even if they exist in your project folder. Go ahead, verify by running:

$ capstan config print
--- global configuration
CAPSTAN_ROOT: /home/miha/.capstan
CAPSTAN_REPO_URL: https://mikelangelo-capstan.s3.amazonaws.com/
CAPSTAN_DISABLE_KVM: false

--- curent directory configuration
CAPSTANIGNORE:
/meta
/mpm-pkg
/.git

Specify your own .capstanignore

Go ahead, create a new file in your project root directory and name it .capstanignore. Below please find a valid .capstanignore file example showing the syntax:

# ignores file 'myfile.txt' in project root directory
/myfile.txt

# ignores file 'myfile.txt' in '/myfolder' directory
/myfolder/myfile.txt

# ignores any file 'myfile.txt' in whole project (recursive)
/**/myfile.txt

# ignores folder 'myfolder' and all its content
/myfolder

# ignores all files and folders inside 'myfolder', but keeps the folder
/myfolder/*

# ignores any file with '.txt' suffix in project root directory
/*.txt

# ignores any file with '.txt' suffix in whole project (recursive)
/**/*.txt

# ignores any file that is inside any first-level directory (e.g. /result/file.txt),
# but keeps the folders
/*/*

As you can see the syntax is that of .gitignore only you need to start each pattern with slash /. Note that negation (!) is not supported. You can see what files are actually getting excluded in your case by using --verbose flag:

$ capstan package collect --verbose
Resolved runtime into: node
Prepending 'node' runtime dependencies to dep list: [app.node-4.4.5]
.capstanignore: ignore /bin
.capstanignore: ignore /bin/osv-launch-services.sh
.capstanignore: ignore /bin/osv-launch-worker.sh
.capstanignore: ignore /bin/upload_batch.sh
.capstanignore: ignore /doc
.capstanignore: ignore /doc/setup-phase.png
.capstanignore: ignore /doc/worker-phase.png