Skip to content

Commit

Permalink
Merge branch 'main' into f/6600-new-uvm-endorsements
Browse files Browse the repository at this point in the history
  • Loading branch information
maxtropets authored Nov 8, 2024
2 parents d5459fc + 7ad8fb7 commit 32f4350
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 52 deletions.
18 changes: 2 additions & 16 deletions doc/build_apps/install_bin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,12 @@ Quickstart
CCF builds and runs on Linux. It is primarily developed and tested on Ubuntu 20.04.
The dependencies required to build and run CCF apps can be conveniently installed using the ``ansible`` playbooks in the CCF repository or `Install`_, depending on the target TEE platform:

.. tab:: SGX

Running CCF with full security guarantees requires :term:`SGX` hardware with :term:`FLC`.
CCF on SGX requires the following dependencies to be first installed on your system:

- :term:`Intel SGX PSW`
- :term:`Azure DCAP`
- :term:`Open Enclave`

.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm/
$ ./run.sh app-dev.yml --extra-vars "platform=sgx" --extra-vars "clang_version=11"
.. tab:: SNP

.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm/
$ ./run.sh app-dev.yml --extra-vars "platform=snp" --extra-vars "clang_version=15"
$ ./run.sh app-dev.yml --extra-vars "platform=snp"
.. tab:: Virtual

Expand All @@ -37,7 +23,7 @@ The dependencies required to build and run CCF apps can be conveniently installe
.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm/
$ ./run.sh app-dev.yml --extra-vars "platform=virtual" --extra-vars "clang_version=15"
$ ./run.sh app-dev.yml --extra-vars "platform=virtual"
This will install the latest release of CCF, but a specific release can also be specified with ``--extra-vars "ccf_ver=X.Y.Z"`` if desired.

Expand Down
11 changes: 2 additions & 9 deletions doc/contribute/build_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,12 @@ First, on your development VM, checkout the CCF repository or :doc:`install the

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

.. tab:: SGX

.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm
$ ./run.sh ccf-dev.yml --extra-vars "platform=sgx"
.. tab:: SNP

.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm
$ ./run.sh ccf-dev.yml --extra-vars "platform=snp clang_version=15"
$ ./run.sh ccf-dev.yml
.. tab:: Virtual

Expand All @@ -29,7 +22,7 @@ Then, to quickly set up the dependencies necessary to build CCF itself and CCF a
.. code-block:: bash
$ cd <ccf_path>/getting_started/setup_vm
$ ./run.sh ccf-dev.yml --extra-vars "platform=virtual clang_version=15"
$ ./run.sh ccf-dev.yml
Once this is complete, you can proceed to :doc:`/build_apps/build_app`.

Expand Down
11 changes: 2 additions & 9 deletions doc/operations/run_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,19 @@ First, follow the steps described in :doc:`/build_apps/install_bin`.

Then, to quickly set up the dependencies necessary to start CCF applications, simply run:

.. tab:: SGX

.. code-block:: bash
$ cd /opt/ccf_sgx/getting_started/setup_vm
$ ./run.sh app-run.yml --extra-vars "platform=sgx" --extra-vars "clang_version=11"
.. tab:: SNP

.. code-block:: bash
$ cd /opt/ccf_snp/getting_started/setup_vm
$ ./run.sh app-run.yml --extra-vars "platform=snp" --extra-vars "clang_version=15"
$ ./run.sh app-run.yml --extra-vars "platform=snp"
.. tab:: Virtual

.. code-block:: bash
$ cd /opt/ccf_virtual/getting_started/setup_vm
$ ./run.sh app-run.yml --extra-vars "platform=virtual" --extra-vars "clang_version=15"
$ ./run.sh app-run.yml --extra-vars "platform=virtual"
Runtime Containers
Expand Down
20 changes: 2 additions & 18 deletions getting_started/setup_vm/ccf-dev.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,12 @@
- hosts: localhost
vars:
platform: "sgx"
clang_version: "11"
platform: "snp"
clang_version: "15"
tasks:
- import_role:
name: llvm_repo
tasks_from: install.yml
when: clang_version == "15"
- import_role:
name: intel
tasks_from: sgx-psw.yml
when: platform == "sgx"
- import_role:
name: intel
tasks_from: sgx-group.yml
when: platform == "sgx"
- import_role:
name: az_dcap
tasks_from: install.yml
when: platform == "sgx"
- import_role:
name: openenclave
tasks_from: binary_install.yml
when: platform == "sgx"
- import_role:
name: nodejs
tasks_from: install.yml
Expand Down

0 comments on commit 32f4350

Please sign in to comment.