Merge pull request #115 from vsoch/docs/2.4

Adding Docs/2.4 Image

Author: vsoch

_data/sidebars/main_sidebar.yml

@@ -47,6 +47,9 @@ entries:
       url: /install-windows
       output: web, pdf
 
+    - title: Host a Singularity Registry
+      url: /singularity-registry
+      output: web, pdf
 
   - title: Contributing
     output: web, pdf

_data/sidebars/user_docs.yml

@@ -15,28 +15,24 @@ entries:
       url: /user-guide
       output: web, pdf
 
-    - title: Quick Start Installation
-      url: /docs-quick-start-installation
+    - title: Installation
+      url: /docs-installation
       output: web, pdf
 
-    - title: Create an Image
-      url: /create-image
+    - title: Quick Start
+      url: /quickstart
       output: web, pdf
 
-    - title: Bootstrap an Image
-      url: /bootstrap-image
+    - title: Singularity Flow
+      url: /docs-flow
       output: web, pdf
 
-    - title: Adding Content
-      url: /image-content
+    - title: Container Recipes
+      url: /docs-recipes
       output: web, pdf
 
-    - title: Container Checks
-      url: /docs-user-checks
-      output: web, pdf
-
-    - title: User Control
-      url: /user-control
+    - title: Build an Image
+      url: /docs-build
       output: web, pdf
 
     - title: Bind Paths and Mounts
@@ -47,22 +43,22 @@ entries:
       url: /docs-instances
       output: web, pdf
 
+    - title: Container Checks
+      url: /docs-user-checks
+      output: web, pdf
+
     - title: Environment and Metadata
       url: /docs-environment-metadata
       output: web, pdf
 
-    - title: Change an Existing Container
-      url: /docs-changing-containers
+    - title: Reproducible SCI-F Apps
+      url: /docs-scif-apps
       output: web, pdf
 
     - title: Singularity and Docker
       url: /docs-docker
       output: web, pdf
 
-    - title: Reproducible SCI-F Apps
-      url: /docs-scif-apps
-      output: web, pdf
-
     - title: Troubleshooting
       url: /faq#troubleshooting
       output: web, pdf
@@ -75,22 +71,14 @@ entries:
       url: /docs-usage
       output: web, pdf
 
-    - title: bootstrap
-      url: /docs-bootstrap
+    - title: build
+      url: /docs-build
       output: web, pdf
 
     - title: exec
       url: /docs-exec
       output: web, pdf
 
-    - title: export
-      url: /docs-export
-      output: web, pdf
-
-    - title: import
-      url: /docs-import
-      output: web, pdf
-
     - title: inspect
       url: /docs-inspect
       output: web, pdf
@@ -106,3 +94,34 @@ entries:
     - title: shell
       url: /docs-shell
       output: web, pdf
+
+
+  - title: Image Commands
+    output: web, pdf
+    folderitems:
+
+    - title: image.export
+      url: /docs-export
+      output: web, pdf
+
+    - title: image.expand
+      url: /docs-expand
+      output: web, pdf
+
+    - title: image.import
+      url: /docs-import
+      output: web, pdf
+
+    - title: image.create
+      url: /docs-create
+      output: web, pdf
+
+
+  - title: Deprecated
+    output: web, pdf
+
+    folderitems:
+    - title: bootstrap
+      url: /docs-bootstrap
+      output: web, pdf
+

_posts/releases/2017-10-02-release-2.4.md

@@ -0,0 +1,54 @@
+---
+title:  "Singularity 2.4 Release"
+category: releases
+permalink: "release-2-4"
+version: "2.4"
+---
+
+Singularity 2.4 is relesed, and here are the important notes for you to know about!
+
+<img src="/assets/img/posts/releases/singularity-egg-easy.png">
+
+
+**Singularity Build**
+Building an image is now more intuitive with the introduction of our `build` command. You don't need to worry about using `create`, or `bootstrap`, you just build. It looks like this:
+
+```
+sudo singularity build container.simg Singularity
+```
+
+If you are tired of needing to estimate your image size, that issue goes away with build. The default format for a Singularity image base is now a smaller, compressed file format called **SquashFS**.  This format is also a much better fit for reproducible containers, as it is immutable. For more details, see our [build](/docs-build) documentation.
+
+**Build Bases**
+We originally supported just using an existing distribution package or docker as a base for building images. With 2.4, we have extended that set to include another Singularity image (`localimage`), a Singularity Hub or Registry image (`shub`) or the host operating system (`self`).
+
+**Instance Support**
+Singularity now has support for instances, which means services! Images instances can be started, stopped, and listed. Along with instances comes **Network Namespace Isolation**. We are excited to see the kinds of use cases that this will afford for our users. 
+
+**Singularity Registry**
+If you want to host your own Registry, we listened and you are in luck! Singularity <a href="https://www.github.com/singularityhub/sregistry">Registry</a> is ready for your use, along with a <a href="https://singularityhub.github.io/containers">portal</a> for you to "register your registry" to make it easier to share your images. Singularity Hub, along with improved building and updated builders, will follow this release.
+
+**Internal Modalarity**
+This release includes support for the <a href="/docs-apps">Standard Container Integration Format (SCI-F)</a> that makes it easy for you to produce single, internally modular and programmatically discoverage containers. More information is provided on it's <a href="https://containers-ftw.github.io/SCI-F/">main site</a>.
+
+**Better Documentation**
+We've added an entire page on the different customizations you can do to the [build environment](/build-environment), including changing the cache and specifying credentials for Docker. 
+
+**Deprecated**
+We are deprecating the original `create` command to be replaced with `image.create`, along with `bootstrap` in favor with build. These commands will still work for 2.4, however we recommend you start testing the updated ones.
+
+In addition, here are some tiny changes for your information!
+
+- Persistent Overlay
+- Container checks
+- Tests for instance support
+- Wrapper for create
+- Group instance commands
+- Group image commands
+- Bash completion updates
+
+For the full release announcement and downloads, please see <a target="_blank" href="https://github.com/singularityware/singularity/releases/tag/2.4">the release on Github</a>.
+
+Wowee, way to go team, contributors, and the community! Please report any issues or questions that you might have to <a href="https://github.com/singularityware/singularity/issues/new" target="_blank">our issue board</a>.
+
+Thank you!

assets/img/diagram/container_treemap.png

@@ -9,9 +9,11 @@ toc: false
 Singularity enables users to have full control of their environment. Singularity containers can be used to package entire scientific workflows, software and libraries, and even data. This means that you don't have to ask your cluster admin to install anything for you - you can put it in a Singularity container and run. Did you already invest in Docker? The Singularity software can import your Docker images without having Docker installed or being a superuser. Need to share your code? Put it in a Singularity container and your collaborator won't have to go through the pain of installing missing dependencies. Do you need to run a different operating system entirely? You can "swap out" the operating system on your host for a different one within a Singularity container. As the user, you are in control of the extent to which your container interacts with its host. There can be seamless integration, or little to no communication at all. What does your workflow look like?
 
 
-<img style="max-width:900px" src="/assets/img/diagram/singularity-2.3-flow.png">
+<a href="/assets/img/diagram/singularity-2.4-flow.png" target="_blank" class="no-after">
+   <img style="max-width:900px" src="/assets/img/diagram/singularity-2.4-flow.png">
+</a>
 
-It's pretty simple. You can make and customize containers locally, and then run them on your shared resource. As of version 2.3, you can even import Docker image content without sudo permissions. Singularity also allows you to leverage the resources of whatever host you are on. This includes HPC interconnects, resource managers, file systems, GPUs and/or accelerators, etc. Singularity does this by enabling several key facets:
+It's pretty simple. You can make and customize containers locally, and then run them on your shared resource. As of version 2.3, you can even pull Docker image layers into a new Singularity image without sudo permissions. Singularity also allows you to leverage the resources of whatever host you are on. This includes HPC interconnects, resource managers, file systems, GPUs and/or accelerators, etc. Singularity does this by enabling several key facets:
 
 * Encapsulation of the environment
 * Containers are image based

assets/img/diagram/singularity-2.4-flow.png

@@ -7,7 +7,7 @@ folder: docs
 
 When Singularity is running via the SUID pathway, the configuration **must** be owned by the root user otherwise Singularity will error out. This ensures that the system administrators have direct say as to what functions the users can utilize when running as root. If Singularity is installed as a non-root user, the SUID components are not installed, and the configuration file can be owned by the user (but again, this will limit functionality).
 
-The Configuration file can be found at `$SYSCONFDIR/singularity/singularity.conf` and is generally self documenting but there are several things to pay special attention to:
+The Configuration file can be found at `$SYSCONFDIR/singularity/singularity.conf`. The template in the repository is located at `etc/singularity.conf`. It is generally self documenting but there are several things to pay special attention to:
 
 ## Parameters