CCF Development Setup¶

Environment Setup¶

First, on your development VM, checkout the CCF repository or install the latest CCF release.

Then, to quickly set up the dependencies necessary to build CCF itself and CCF applications, simply run:

SNP

$ cd <ccf_path>/getting_started/setup_vm
$ ./run.sh ccf-dev.yml

Virtual

Warning

The virtual version of CCF can also be run on hardware that does not support SEV-SNP. Virtual mode does not provide any security guarantees and should be used for development purposes only.

$ cd <ccf_path>/getting_started/setup_vm
$ ./run.sh ccf-dev.yml

Once this is complete, you can proceed to Build CCF Applications.

Build Container¶

The quickest way to get started building CCF applications is to use the CCF build container. It contains all the dependencies needed to build and test CCF itself as well as CCF applications.

$ export VERSION="4.0.0"
$ export PLATFORM="snp" # snp or virtual
$ docker pull mcr.microsoft.com/ccf/app/dev:$VERSION-$PLATFORM

The container contains the latest release of CCF along with a complete build toolchain, and startup scripts.

Note

virtual mode provides no security guarantee. It is only useful for development and prototyping.

Visual Studio Code Setup¶

If you use Visual Studio Code you can install the Remote Container extension and use the sample devcontainer.json config. More details on that process.