Skip to content

Commit

Permalink
Merge pull request #69 from 10x-Engineers/alitariq4589/sandboxing_update
Browse files Browse the repository at this point in the history 
Added Banana Pi F3 documentation
  • Loading branch information
@mmhus
mmhus authored Aug 29, 2024
2 parents cc0c29e + 4c4b63f commit 0e88ee7
Show file tree
Hide file tree
Showing 27 changed files with 708 additions and 85 deletions.
9 changes: 7 additions & 2 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@
<li class="toctree-l1"><a class="reference internal" href="/.">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/Software_Developer_Guide/">Getting Started</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/Software_Developer_Guide/">Setting up CI</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/Creating_jenkinsfile/">Creating a CI pipeline file</a>
Expand All @@ -62,6 +65,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="/tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand Down
9 changes: 7 additions & 2 deletions docs/Creating_CI_CD_pipeline/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Getting Started</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Setting up CI</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Creating_jenkinsfile/">Creating a CI pipeline file</a>
Expand All @@ -69,6 +72,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand Down
13 changes: 9 additions & 4 deletions docs/Creating_jenkinsfile/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Getting Started</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Setting up CI</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Creating a CI pipeline file</a>
Expand Down Expand Up @@ -93,6 +96,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand Down Expand Up @@ -226,7 +231,7 @@ <h2 id="reference-links">Reference Links</h2>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../Software_Developer_Guide/" class="btn btn-neutral float-left" title="Getting Started"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../sandboxing/" class="btn btn-neutral float-left" title="Setting up SSH/Sandboxing"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../runner_specs/" class="btn btn-neutral float-right" title="Compute Instance Specifications">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

Expand All @@ -250,7 +255,7 @@ <h2 id="reference-links">Reference Links</h2>
<span class="rst-current-version" data-toggle="rst-current-version">


<span><a href="../Software_Developer_Guide/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../sandboxing/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../runner_specs/" style="color: #fcfcfc">Next &raquo;</a></span>
Expand Down
9 changes: 7 additions & 2 deletions docs/Multinode_Pipelines/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Getting Started</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Setting up CI</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Creating_jenkinsfile/">Creating a CI pipeline file</a>
Expand All @@ -69,6 +72,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand Down
87 changes: 61 additions & 26 deletions docs/Software_Developer_Guide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Getting Started - Cloud-V Docs</title>
<title>Setting up CI - Cloud-V Docs</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<script>
// Current page data
var mkdocs_page_name = "Getting Started";
var mkdocs_page_name = "Setting up CI";
var mkdocs_page_input_path = "Software_Developer_Guide.md";
var mkdocs_page_url = null;
</script>
Expand Down Expand Up @@ -43,29 +43,44 @@
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Getting Started</a>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Setting up CI</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#pre-requisites">Pre-requisites</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#getting-an-account-for-cloud-v">Getting an account for Cloud-V</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#setting-up-cloud-v-pipeline-inside-github-project-repository">Setting up cloud-v-pipeline inside github project repository</a>
<li class="toctree-l2"><a class="reference internal" href="#setting-up-repository-with-cloud-v">Setting up repository with Cloud-V</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#using-cloud-v-automatic-integration-beta">Using Cloud-V automatic integration (beta)</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#for-github">For GitHub</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#setting-credentials-for-webhook">Setting credentials for webhook</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#obtaining-github-access-token-for-repository">Obtaining github access token for repository</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#configuring-repository-webhook">Configuring repository webhook</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#setting-up-cloud-v-pipeline-inside-github-project-repository">Setting up cloud-v-pipeline inside github project repository</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#configurations-inside-cloud-v">Configurations inside Cloud-V</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#requirements-for-administrator">Requirements for administrator</a>
</li>
</ul>
</li>
</li>
<li class="toctree-l1"><a class="reference internal" href="../sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Creating_jenkinsfile/">Creating a CI pipeline file</a>
Expand All @@ -89,6 +104,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand All @@ -106,7 +123,8 @@
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Getting Started</li>
<li class="breadcrumb-item">Getting Started</li>
<li class="breadcrumb-item active">Setting up CI</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
Expand All @@ -123,24 +141,25 @@ <h2 id="pre-requisites">Pre-requisites</h2>
<li>GitHub project repository with owner rights.</li>
</ol>
<h2 id="getting-an-account-for-cloud-v">Getting an account for Cloud-V</h2>
<p>Fill out <a href="https://docs.google.com/forms/d/e/1FAIpQLSdr8qRF3blH0Jv0dfWhasu6t0IwC0h2II8q2U6keM3vhKoYlQ/viewform?usp=sf_link">this</a> google form with all the required information for getting an account on Cloud-V.</p>
<p>After this we will get back to you with login credentials.</p>
<h2 id="setting-up-cloud-v-pipeline-inside-github-project-repository">Setting up <code>cloud-v-pipeline</code> inside github project repository</h2>
<p>Cloud-V will need a <code>cloud-v-pipeline</code> written with jenkinsfile pipeline syntax to start execution of tests/checks (see <a href="https://www.jenkins.io/doc/book/pipeline/syntax/">link</a>). This pipeline will contain all the stages (and may be steps) of a CI/CD pipeline. This pipeline can be <code>scripted pipeline</code> which will only have stages or it can also be <code>declarative pipeline</code> which may also have steps inside stages. </p>
<p>A simple scripted <code>Helloworld</code> pipeline in linux is as follows:</p>
<pre><code class="language-shell">
node{
stage('*** Phase 1 ***') {
//Using bash commands
sh '''#!/bin/bash
echo &quot;Hello World !\n&quot;
'''
}
}
</code></pre>
<p>Upon execution of such a pipeline, the console output can be viewed as follows. </p>
<p><img alt="Console Output" src="../doc_images/Console output for Hello World.png" /></p>
<p><em><strong>Note:</strong> This cloud-v-pipeline should remain same in all the branches and pull requests.</em> </p>
<p>You can request Cloud-V access via <a href="https://cloud-v.co/contactus">Cloud-V contact-us page</a>.</p>
<p>After requesting the account, Cloud-V team will have a meeting with you and will give you access to the platform accordingly.</p>
<h2 id="setting-up-repository-with-cloud-v">Setting up repository with Cloud-V</h2>
<h3 id="using-cloud-v-automatic-integration-beta">Using Cloud-V automatic integration (beta)</h3>
<p>For ease of convinience for users and eliminating time delays of manual set up, users can add their GitHub and GitLab repository in Cloud-V by just adding their repository URL on the Cloud-V page. The source code for this is open-source <a href="https://github.com/10x-Engineers/Cloud-V-git-automation">here</a>.</p>
<h4 id="for-github">For GitHub</h4>
<p>For integrating user repository with Cloud-V, there is a GitHub app which users can install in their repository. The purpose of creating the app and publishing it for users is that, GitHub app has all the permissions already set up. So, when a user installs GitHub app, the app automatically sets up all the permissions for the user's repository.</p>
<p>Following is the procedure for installing and integrating the repository with Cloud-V github app and for creating the CI pipeline in Cloud-V dashboard.</p>
<ul>
<li>Visit this <a href="https://github.com/apps/cloud-v-github-integration">link</a> for installing GitHub app.</li>
<li>Click on "Install" button which will take you to permissions page where you can select the permissions for the repository and also choose the repository which you would like to integrate with Cloud-V app</li>
<li>Select "Only select repositories" if you would like to integrate a specific repository or number of repositories instead of integrating Cloud-V app with all the repositories.</li>
<li>Click on "Install &amp; Authorize" which will take you to the page where you can add repository URL</li>
<li>Add repository URL and click on "Submit"</li>
<li>The next page will show you:</li>
<li>Access Token (will be visible one-time)</li>
<li>URL of the GitHub repository which is configured (currently, one token can be configured with one repository)</li>
<li>The link of the CI pipeline which is created automatically in Cloud-V CI dashboard </li>
</ul>
<h2 id="setting-credentials-for-webhook">Setting credentials for webhook</h2>
<p>Cloud-V supports webhooks which can trigger the job from external sources such as GitHub. They work in a way such that, if a specified branch is committed or if a pull request is created, the specified job build starts running depending upon the trigger event which is set in build's configuration in Cloud-V. </p>
<p>This process requires access token of the repository <strong>CREATED BY OWNER OF REPOSITORY</strong> on which the webhook is to be set. These credentials can be safely added to Cloud-V without anyone (even administrator) seeing the passwords as follows.</p>
Expand Down Expand Up @@ -189,6 +208,22 @@ <h3 id="configuring-repository-webhook">Configuring repository webhook</h3>
</ul>
<p>Webhook settings will look something like this:</p>
<p><img alt="webhook_settings" src="../doc_images/webhook-settings1.png" /> </p>
<h2 id="setting-up-cloud-v-pipeline-inside-github-project-repository">Setting up <code>cloud-v-pipeline</code> inside github project repository</h2>
<p>Cloud-V will need a <code>cloud-v-pipeline</code> written with jenkinsfile pipeline syntax to start execution of tests/checks (see <a href="https://www.jenkins.io/doc/book/pipeline/syntax/">link</a>). This pipeline will contain all the stages (and may be steps) of a CI/CD pipeline. This pipeline can be <code>scripted pipeline</code> which will only have stages or it can also be <code>declarative pipeline</code> which may also have steps inside stages. </p>
<p>A simple scripted <code>Helloworld</code> pipeline in linux is as follows:</p>
<pre><code class="language-shell">
node{
stage('*** Phase 1 ***') {
//Using bash commands
sh '''#!/bin/bash
echo &quot;Hello World !\n&quot;
'''
}
}
</code></pre>
<p>Upon execution of such a pipeline, the console output can be viewed as follows. </p>
<p><img alt="Console Output" src="../doc_images/Console output for Hello World.png" /></p>
<p><em><strong>Note:</strong> This cloud-v-pipeline should remain same in all the branches and pull requests.</em> </p>
<h3 id="configurations-inside-cloud-v">Configurations inside Cloud-V</h3>
<p><em><strong>Note:</strong> Currently users are not able to see or modify pipeline build configuration inside Jenkins, that is currently managed by administrator. Users are requested to inform administrator about how they want their pipeline configured.</em></p>
<ul>
Expand Down Expand Up @@ -244,7 +279,7 @@ <h2 id="requirements-for-administrator">Requirements for administrator</h2>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../Creating_jenkinsfile/" class="btn btn-neutral float-right" title="Creating a CI pipeline file">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../sandboxing/" class="btn btn-neutral float-right" title="Setting up SSH/Sandboxing">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand All @@ -270,7 +305,7 @@ <h2 id="requirements-for-administrator">Requirements for administrator</h2>
<span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../Creating_jenkinsfile/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../sandboxing/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
Expand Down
9 changes: 7 additions & 2 deletions docs/Tooling/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Getting Started</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Software_Developer_Guide/">Setting up CI</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../sandboxing/">Setting up SSH/Sandboxing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Creating_jenkinsfile/">Creating a CI pipeline file</a>
Expand Down Expand Up @@ -73,6 +76,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-BPF3-x/">J-BPF3-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
Expand Down
Binary file added docs/doc_images/open-remote-extension.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0e88ee7

Please sign in to comment.