Commit a78701d1 authored by Luca Cinquini's avatar Luca Cinquini
Browse files

Updating documentation

parent 03bd3b09

.buildinfo

+1 −1
Original line number Diff line number Diff line 
# Sphinx build info version 1

# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.

config: 4d3597b4651c71301cf359fad5392948

config: 381e22fae4225e2018cada5b04340b97

tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/single_host_deployment.rst.txt

+5 −1
Original line number Diff line number Diff line
@@ -30,7 +30,11 @@ Cleanup 
If you are following these instructions *not* for the first time,

it might be a good idea to completely reset the system so you can start from a clean slate. To do so,

stop all running containers, and remove all data volumes and all configuration.

From the top-level *esgf-docker/* directory, issue the commands::

Make sure that the environment ESGF_CONFIG is set to your previously chosen value, for example::

   

    export ESGF_CONFIG=~/esgf_config



Then, from the top-level *esgf-docker/* directory, issue the commands::



    docker-compose down

    docker rm $(docker ps -a -q)

_static/basic.css

+7 −0
Original line number Diff line number Diff line
@@ -398,6 +398,13 @@ table.field-list td, table.field-list th { 
    margin: 0;

}



.field-name {

    -moz-hyphens: manual;

    -ms-hyphens: manual;

    -webkit-hyphens: manual;

    hyphens: manual;

}



/* -- other body styles ----------------------------------------------------- */



ol.arabic {

architecture_and_development_guidelines.html

+8 −11
Original line number Diff line number Diff line 


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">





<html xmlns="http://www.w3.org/1999/xhtml">

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    

    <title>Architecture and Development Guidelines &#8212; ESGF-Docker Documentation</title>

    

    <link rel="stylesheet" href="_static/nature.css" type="text/css" />

    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

    

    <script type="text/javascript">

      var DOCUMENTATION_OPTIONS = {

        URL_ROOT:    './',
@@ -29,7 +26,7 @@ 
    <link rel="next" title="Docker Swarm Setup on MacOSX" href="docker_swarm_setup_on_macosx.html" />

    <link rel="prev" title="Data Publishing" href="data_publishing.html" /> 

  </head>

  <body role="document">

  <body>

    <div class="related" role="navigation" aria-label="related navigation">

      <h3>Navigation</h3>

      <ul>
@@ -63,14 +60,14 @@ specific images are derived. This design has several benefits:</p> 
<ul class="simple">

<li>All images run the same version of the core OS, libraries and engines such

as Centos, Java, Python, SSL, Tomcat, etc.</li>

<li>It&#8217;s easy to propagate updates of any of these components to all images.</li>

<li>It’s easy to propagate updates of any of these components to all images.</li>

<li>Common building instructions are not repeated, in different form, in different Dockerfiles.</li>

</ul>

<p>The current version of the ESGF image hierarchy is shown in the figure below.</p>

</div>

<div class="section" id="image-content">

<h2>Image Content<a class="headerlink" href="#image-content" title="Permalink to this headline"></a></h2>

<p>For maximum flexibility, and conforming to the &#8220;micro-services&#8221;

<p>For maximum flexibility, and conforming to the “micro-services”

architecture, each ESGF image should contain only one service,

interacting with the other ESGF services through publicly exposed

endpoints. In some cases though a set of services must be co-located as
@@ -98,7 +95,7 @@ this repository.</p> 
</div>

<div class="section" id="supervisor">

<h2>Supervisor<a class="headerlink" href="#supervisor" title="Permalink to this headline"></a></h2>

<p>ESGF images should use the Python program &#8220;Supervisor&#8221; to start and

<p>ESGF images should use the Python program “Supervisor” to start and

monitor services inside a Docker container. Benefits of using Supervisor

include:</p>

<ul class="simple">
@@ -107,7 +104,7 @@ service from inside each container.</li> 
<li>Ability to add services to the

startup pool by simply dropping configuration files in a standard location.</li>

<li>Ability to start/stop/restart entire group of services (for example, all Solr shards at once).</li>

<li>Ability to start services as non-privileged users such as &#8220;tomcat&#8221;, &#8220;apache&#8221;, etc.</li>

<li>Ability to start services as non-privileged users such as “tomcat”, “apache”, etc.</li>

</ul>

<p>Supervisor is installed as part of the <em>esgf-node</em> base image, and started by default unless a child image

overrides the Docker CMD instruction.</p>
@@ -130,7 +127,7 @@ configuration, such as SSL certificates, hostnames, passwords etc. At 
this time, all site-specific configuration is stored in a directory tree

rooted at $ESGF_CONFIG/, which is cross-mounted as a shared volume on

on all containers. In the future, the site-specific configuration might

be &#8220;pushed&#8221; to the containers via other means.</p>

be “pushed” to the containers via other means.</p>

</div>

<div class="section" id="persistent-data">

<h2>Persistent Data<a class="headerlink" href="#persistent-data" title="Permalink to this headline"></a></h2>
@@ -215,7 +212,7 @@ upgrades.</p> 
    </div>

    <div class="footer" role="contentinfo">

        &#169; Copyright 2017, ESGF.

      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.

      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.

    </div>

  </body>

</html>
 
 No newline at end of file

data_publishing.html

+4 −7
Original line number Diff line number Diff line 


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">





<html xmlns="http://www.w3.org/1999/xhtml">

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    

    <title>Data Publishing &#8212; ESGF-Docker Documentation</title>

    

    <link rel="stylesheet" href="_static/nature.css" type="text/css" />

    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

    

    <script type="text/javascript">

      var DOCUMENTATION_OPTIONS = {

        URL_ROOT:    './',
@@ -29,7 +26,7 @@ 
    <link rel="next" title="Architecture and Development Guidelines" href="architecture_and_development_guidelines.html" />

    <link rel="prev" title="Multiple Hosts Deployment" href="multiple_hosts_deployment.html" /> 

  </head>

  <body role="document">

  <body>

    <div class="related" role="navigation" aria-label="related navigation">

      <h3>Navigation</h3>

      <ul>
@@ -161,7 +158,7 @@ and insert the following policy statement (as XML):</p> 
</pre></div>

</div>

<p>After about a minute, the dataset and file should be returned when

querying the &#8220;slave&#8221; Solr index:</p>

querying the “slave” Solr index:</p>

<ul class="simple">

<li><a class="reference external" href="http://my-node.esgf.org/solr/#/datasets/query">http://my-node.esgf.org/solr/#/datasets/query</a></li>

<li><a class="reference external" href="http://my-node.esgf.org/solr/#/files/query">http://my-node.esgf.org/solr/#/files/query</a></li>
@@ -237,7 +234,7 @@ CoG user interface, if the project has searching enabled:</p> 
    </div>

    <div class="footer" role="contentinfo">

        &#169; Copyright 2017, ESGF.

      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.

      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.

    </div>

  </body>

</html>
 
 No newline at end of file