Skip to content

Commit 2b33a2b

Browse files
committed
Update docs to 3.6.2
1 parent 429545d commit 2b33a2b

8 files changed

Lines changed: 12 additions & 11 deletions

File tree

docs/_sources/source/compute_config/azure_vms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ lithops logs poll
164164
165165
## VM Management
166166
167-
Lithops for Azure VMs follows a Mater-Worker architecture (1:N).
167+
Lithops for Azure VMs follows a Master-Worker architecture (1:N).
168168
169169
All the VMs, including the master VM, are automatically stopped after a configurable timeout (see hard/soft dismantle timeouts).
170170

docs/_sources/source/compute_config/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ k8s:
4343
....
4444
docker_server : docker.io
4545
docker_user : <Docker hub Username>
46-
docker_password : <DOcker hub access TOEKN>
46+
docker_password : <Docker hub access TOKEN>
4747
```
4848

4949
### Configure IBM Container Registry

docs/_sources/source/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Choose your compute and storage engines from the table below:
2929
|| `Azure Container Apps <compute_config/azure_containers.html>`_ || `Redis <storage_config/redis.html>`_ |
3030
|| `Aliyun Function Compute <compute_config/aliyun_functions.html>`_ || `OpenStack Swift <storage_config/swift.html>`_ |
3131
|| `Oracle Functions <compute_config/oracle_functions.html>`_ || `Oracle Object Storage <storage_config/oracle_oss.html>`_ |
32-
|| `Kubernetes <compute_config/Kubernetes.html>`_ || |
32+
|| `Kubernetes <compute_config/kubernetes.md>`_ || |
3333
|| `Knative <compute_config/knative.html>`_ || |
3434
|| `Singularity <compute_config/singularity.html>`_ || |
3535
|| `OpenWhisk <compute_config/openwhisk.html>`_ || |

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/source/api_storage.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -699,8 +699,9 @@ <h2>Storage API Reference<a class="headerlink" href="#storage-api-reference" tit
699699
<dl class="py method">
700700
<dt class="sig sig-object py" id="lithops.storage.storage.Storage.list_objects">
701701
<span class="sig-name descname"><span class="pre">list_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bucket</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lithops.storage.storage.Storage.list_objects" title="Permalink to this definition">#</a></dt>
702-
<dd><p>Returns all of the object keys in a bucket. For each object, the list contains the name
703-
of the object (key) and the size.</p>
702+
<dd><p>Returns all of the object keys in a bucket. For each object, the list contains a dictionary
703+
with at least the object key (‘Key’) and the size in bytes (‘Size’). Additional fields may be
704+
present, depending on the backend implementation.</p>
704705
<dl class="field-list simple">
705706
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
706707
<dd class="field-odd"><ul class="simple">
@@ -710,10 +711,10 @@ <h2>Storage API Reference<a class="headerlink" href="#storage-api-reference" tit
710711
</ul>
711712
</dd>
712713
<dt class="field-even">Returns<span class="colon">:</span></dt>
713-
<dd class="field-even"><p>List of tuples containing the object key and size in bytes</p>
714+
<dd class="field-even"><p>List of dictionaries containing at least ‘Key’ and ‘Size’ for each object</p>
714715
</dd>
715716
<dt class="field-odd">Return type<span class="colon">:</span></dt>
716-
<dd class="field-odd"><p><em>List</em>[<em>Tuple</em>[str, int]]</p>
717+
<dd class="field-odd"><p><em>List</em>[<em>Dict</em>[str, <em>Any</em>]]</p>
717718
</dd>
718719
</dl>
719720
</dd></dl>

docs/source/compute_config/azure_vms.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ <h2>Viewing the execution logs<a class="headerlink" href="#viewing-the-execution
775775
</section>
776776
<section id="vm-management">
777777
<h2>VM Management<a class="headerlink" href="#vm-management" title="Permalink to this heading">#</a></h2>
778-
<p>Lithops for Azure VMs follows a Mater-Worker architecture (1:N).</p>
778+
<p>Lithops for Azure VMs follows a Master-Worker architecture (1:N).</p>
779779
<p>All the VMs, including the master VM, are automatically stopped after a configurable timeout (see hard/soft dismantle timeouts).</p>
780780
<p>You can login to the master VM and get a live ssh connection with:</p>
781781
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>lithops<span class="w"> </span>attach<span class="w"> </span>-b<span class="w"> </span>azure_vms

docs/source/compute_config/kubernetes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ <h3>Configure Docker hub<a class="headerlink" href="#configure-docker-hub" title
466466
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">....</span>
467467
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker_server</span><span class="w"> </span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io</span>
468468
<span class="w"> </span><span class="nt">docker_user </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;Docker hub Username&gt;</span>
469-
<span class="w"> </span><span class="nt">docker_password </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;DOcker hub access TOEKN&gt;</span>
469+
<span class="w"> </span><span class="nt">docker_password </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;Docker hub access TOKEN&gt;</span>
470470
</pre></div>
471471
</div>
472472
</section>

docs/source/configuration.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h2>Compute and Storage backends<a class="headerlink" href="#compute-and-storage
446446
<div class="line"><a class="reference external" href="compute_config/azure_containers.html">Azure Container Apps</a></div>
447447
<div class="line"><a class="reference external" href="compute_config/aliyun_functions.html">Aliyun Function Compute</a></div>
448448
<div class="line"><a class="reference external" href="compute_config/oracle_functions.html">Oracle Functions</a></div>
449-
<div class="line"><a class="reference external" href="compute_config/Kubernetes.html">Kubernetes</a></div>
449+
<div class="line"><a class="reference internal" href="compute_config/kubernetes.html"><span class="doc">Kubernetes</span></a></div>
450450
<div class="line"><a class="reference external" href="compute_config/knative.html">Knative</a></div>
451451
<div class="line"><a class="reference external" href="compute_config/singularity.html">Singularity</a></div>
452452
<div class="line"><a class="reference external" href="compute_config/openwhisk.html">OpenWhisk</a></div>

0 commit comments

Comments
 (0)