sgx-lkl icon indicating copy to clipboard operation
sgx-lkl copied to clipboard

Move any non-Docker disk creation flows from README to separate docs

Open letmaik opened this issue 5 years ago • 4 comments

I suggest to remove the following subsections in the "### 2. Creating SGX-LKL disk images with sgx-lkl-disk" section:

  • "#### Creating Alpine-based disk images"
  • "#### Creating plain disk images"

I also think the following sections can be removed:

  • "### 3. Running applications from the Alpine Linux repository"
  • "### 4. OpenJDK Java Virtual Machine (JVM)"
  • "### 5. Cross-compiling applications for SGX-LKL"

The result is something along the lines of "use docker" and look at the samples for specific workloads (like Java).

EDIT: Instead of removing completely, the non-Docker parts may go into separate docs, with the main README only having a simple Getting Started sample.

letmaik avatar Jun 03 '20 12:06 letmaik

I agree that Java and cross-compilation should go, and instead become sample applications. I still think that there is value in supporting a particular distro (Alpine) directly.

prp avatar Jun 03 '20 12:06 prp

That doesn't scale. Either we offer generic mechanisms (e.g. Docker), or we have to add support for other distributions as well, like --ubuntu in the future, but I think that's a bad idea.

letmaik avatar Jun 03 '20 12:06 letmaik

Right, I would only keep it for the moment when Alpine is the only supported distribution. Once that limitations has disappeared, I agree that it should be removed.

prp avatar Jun 03 '20 12:06 prp

I would then (re)move the following:

  • "#### Creating plain disk images"
  • "### 3. Running applications from the Alpine Linux repository"
  • "### 4. OpenJDK Java Virtual Machine (JVM)"
  • "### 5. Cross-compiling applications for SGX-LKL"

Note that 3. is outdated and not working anyway, and I think superseded by Docker since that involves a more production type disk setup.

letmaik avatar Jun 03 '20 13:06 letmaik