blob: 75652966b312279873b59d197e5c5ee1bd1a4773 [file] [log] [blame]
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="stylesheet" href="/packages/assets/bootstrap/bootstrap.min.css">
<title>Helm chart repository</title>
<link rel="stylesheet" href="/packages/assets/css/style.css">
<script src="/packages/assets/js/code.js"></script>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:image" content="https://eclipse.org/packages/images/icon/twitter_icon.png"/>
<meta name="twitter:title" content="Helm chart repository"/>
<meta name="twitter:description" content=""/>
<link rel="icon" type="image/svg+xml" href="/packages/images/icon/icon.svg" sizes="any">
<link rel="icon" href="/packages/images/icon/icon.png" sizes="192x192">
<link rel="apple-touch-icon-precomposed" href="/packages/images/icon/icon_apple.png" sizes="180x180">
</head>
<body>
<header>
<nav class="navbar navbar-expand-md fixed-top navbar-light bg-light">
<div class="container">
<a class="navbar-brand" href="/packages/">
<img src="/packages/images/icon_brand_navbar.svg" width="30" height="30" alt="Eclipse IoT Packages™">
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="navbar-nav mr-auto"><li class="nav-item">
<a
class="nav-link"
href="/packages/">Home</a>
</li>
<li class="nav-item">
<a
class="nav-link"
href="/packages/about/">About</a>
</li>
<li class="nav-item">
<a
class="nav-link"
href="/packages/faq/">FAQ</a>
</li>
<li class="nav-item">
<a
class="nav-link"
href="/packages/contribute/">Contribute</a>
</li>
<li class="nav-item">
<a
class="nav-link"
href="/packages/prereqs/">Prerequisites</a>
</li>
<li class="nav-item">
<a
class="nav-link active"
href="/packages/repository/">Repository</a>
</li>
</ul>
</div>
</div>
</nav></header>
<main id="main" role="main" >
<div class="container mt-5">
<div class="row">
<div class="col-12 col-sm-9 col-xl-8">
<h1>Helm chart repository</h1>
<p class="lead">All the charts, in a single location.</p></div>
</div>
</div>
<div class="container">
<p>The Eclipse IoT Packages™ project decided to host a Helm chart repository in order to share the
effort of validating and publishing charts. Eclipse IoT projects are welcome to re-use that
infrastructure to publish their charts, whether they are part of an IoT package or not. Of course
projects can still host their own repositories and charts.</p>
<p>This repository is intended to work with Helm version 2 and 3. Features which work only with Helm 3
are labeled explicitly.</p>
<h2 id="adding-the-repository">Adding the repository</h2>
<p>You can add the repository with a simple command:</p>
<div class="clipboard"><pre><code>helm repo add eclipse-iot https://eclipse.org/packages/charts</code></pre></div>
<p>This will add the repository, using the name <code class="language-plaintext highlighter-rouge">eclipse-iot</code>. Of course you may choose
a different name here. Just take extra care when working through tutorials, as they will
expect the name to be <code class="language-plaintext highlighter-rouge">eclipse-iot</code>.</p>
<p>After you have added the repository you should tell helm to download the index for its contents:</p>
<div class="clipboard"><pre><code>helm repo update</code></pre></div>
<h2 id="see-the-content-helm-v3">See the content <small><span class="badge badge-secondary">Helm v3</span></small></h2>
<p>You can browse through the content using:</p>
<div class="clipboard"><pre><code>helm search repo</code></pre></div>
<p>If you also want the search to include charts that are still under development, e.g. <em>alpha</em>, <em>beta</em> and <em>pre-release</em> versions:</p>
<div class="clipboard"><pre><code>helm search repo --devel</code></pre></div>
<p>If you want to search for <em>charts</em> only, then you can use</p>
<div class="clipboard"><pre><code>helm search repo iot-chart</code></pre></div>
<p>and if you want to search for <em>packages</em> only</p>
<div class="clipboard"><pre><code>helm search repo iot-package</code></pre></div>
<h2 id="how-chart-publishing-works">How chart publishing works</h2>
<p>All chart changes will be verified by a <a href="https://github.com/eclipse/packages/actions">Github action</a>, this is done on every pull request.</p>
<p>Once a pull request is merged, the updated chart will be deployed by a <a href="https://ci.eclipse.org/packages/job/Website/job/master/">Jenkins job</a>.
This job takes care of publishing the resources and generating an updated <code class="language-plaintext highlighter-rouge">index.yaml</code>.</p>
</div>
</main>
<footer class="page-footer">
<div class="container">
<div class="row">
<div class="col-6 col-md">
<h5>Eclipse IoT Packages</h5>
<ul class="list-unstyled">
<li>
<a class="text-muted" href="/packages/">Home</a>
</li>
<li>
<a class="text-muted" href="/packages/about">About</a>
</li>
<li>
<a class="text-muted" href="/packages/contribute">Contribute</a>
</li>
<li>
<a class="text-muted" href="https://eclipse.org/security">Security</a>
</li>
</ul>
</div>
<div class="col-6 col-md">
<h5>Eclipse IoT</h5>
<ul class="list-unstyled">
<li>
<a class="text-muted" href="https://iot.eclipse.org">Top Level Project</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/org/workinggroups/iotwg_charter.php">Working group</a>
</li>
</ul>
</div>
<div class="col-6 col-md">
<h5>Legal</h5>
<ul class="list-unstyled">
<li>
<a class="text-muted" href="https://www.eclipse.org/legal/privacy.php">Privacy Policy</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/legal/termsofuse.php">Terms of Use</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/legal/copyright.php">Copyright Agent</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/legal/epl-2.0/">Eclipse Public License</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/legal">Legal Resources</a>
</li>
</ul>
</div>
<div class="col-6 col-md">
<h5>Eclipse Foundation</h5>
<ul class="list-unstyled">
<li>
<a class="text-muted" href="https://eclipse.org/org">About us</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/org/foundation/contact.php">Contact us</a>
</li>
<li>
<a class="text-muted" href="https://www.eclipse.org/org/foundation/directors.php">Board of Directors</a>
</li>
</ul>
</div>
</div>
<div class="row">
<div class="col-12 col-md text-muted">Copyright © Eclipse Foundation, Inc. All Rights Reserved.</div>
</div>
</div>
</footer>
<script src="/packages/assets/popper.min.js"></script>
<script src="/packages/assets/jquery.min.js"></script>
<script src="/packages/assets/bootstrap/bootstrap.min.js"></script>
<script src="/packages/assets/clipboard.min.js"></script>
<script src="/packages/assets/clipboard.js"></script>
</body>
</html>