deploy: 7d516fc

.buildinfo

@@ -0,0 +1,4 @@
+# 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: 1e1fa9dffe0ce62d769806e304ef907b
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/becoming_eco_lab_partner.rst.txt

@@ -0,0 +1,87 @@
+==========================================
+Becoming an RISC-V Ecosystem Labs Partner
+==========================================
+
+++++++++++++++++++++++++++++++++++++++++++
+Overview
+++++++++++++++++++++++++++++++++++++++++++
+
+A broad and robust software ecosystem is key to the success of RISC-V.
+The RISC-V Ecosystem Labs program
+brings together member companies from across the ecosystem to give developers the
+resources they need to build and test their software, from porting of existing
+projects to development of new components that will power the next wave of computing
+innovation.
+
+RISC-V Ecosystem Lab Partners provide one or more of the following:
+
+- Continuous Integration (CI) testing of open source software projects
+- CI testing resources for use by open source communities to use on their projects
+- “Sandbox” instances of RISC-V physical and virtual hardware for open source communities and projects
+
+For more information about the RISC-V Ecosystem Labs program, please see the
+`RISC-V Ecosystem Labs page <https://riscv.org/risc-v-labs/>`_ on the RISC-V website.
+
+++++++++++++++++++++++++++++++++++++++++++
+Membership
+++++++++++++++++++++++++++++++++++++++++++
+
+The RISC-V Ecosystem Lab Partner Program requires membership in RISC-V.
+Information about membership and the various levels can be found on the
+`RISC-V Membership page <https://riscv.org/membership/>`_.  See the webpage
+for contact information for any additional questions.
+
+Additional information about joining RISC-V and getting on-board as a 
+contributing member, can be found in the 
+`RISC-V Getting Started Guide <https://docs.google.com/document/d/1Qjf6BwMmtqTfzftr3WWf2bRv8Cl4f0qZrWWbr0jCBSU/>`_.
+
+++++++++++++++++++++++++++++++++++++++++++
+Community
+++++++++++++++++++++++++++++++++++++++++++
+
+The Development Partners program is located in the RISC-V Portal community
+`Lab Partners <https://lists.riscv.org/g/lab-partners>`_.  Individuals
+may join this community by selecting "Join" at the bottom of the page.
+
+Community mailing list archives can be found on the community 
+`"Messages" tab <https://lists.riscv.org/g/lab-partners/topics>`_.  To send
+an email to the community, simply email 
+`[email protected] <mailto:[email protected]>`_.
+
+++++++++++++++++++++++++++++++++++++++++++
+Meetings
+++++++++++++++++++++++++++++++++++++++++++
+
+The Lab Partner community meets every 2 weeks.  Agendas are published to the mailing list 
+a day or two in advance of the meetings.  Meeting minutes are collected in the
+`Labs Group Minutes <https://docs.google.com/document/d/1HybKCHVE3KahfEiORgNRcmzVCqqFYVYVOLxjsKMz8gI/>`_
+document in Google Drive.  All RISC-V members have comment access to the document.  Post a comment
+against the document to request Edit access.
+
+The meetings serve as a time for certified Ecosystem Lab members and newer members to exchange status,
+work toward additional member certification, share status of existing labs, and collaborate to solve
+common problems.
+
+++++++++++++++++++++++++++++++++++++++++++
+Becoming and Ecosystem Lab Partner
+++++++++++++++++++++++++++++++++++++++++++
+
+To become a certified RISC-V Ecosystem Partner, members must meet the criteria defined in the
+`RISC-V Labs Policy <https://docs.google.com/document/d/1wGpXaGeM1soTCi5rSYpaL8IwdlTHwSZiGc_5oSiJtxk/edit?usp=sharing>`_.
+The RISC-V Staff and members of the Ecosystem Labs Partners will assist in helping you make decisions
+and work through the requirements.
+
+By completing the work, certified RISC-V Ecosystem Partnes earn the right to display the 
+RISC-V Ecosystem Lab Partner badge on their website.
+
+.. image:: https://riscv.org/wp-content/uploads/2023/11/RV-Lab-Partner.png
+   :width: 400
+   :alt: RISC-V Ecosystem Lab Partner badge
+
+++++++++++++++++++++++++++++++++++++++++++
+Questions
+++++++++++++++++++++++++++++++++++++++++++
+
+Questions about the RISC-V Ecosystem Lab Partners program can be directed to the RISC-V Ecosystem
+Lab Partners mailing list at `[email protected] <mailto:[email protected]>`_ or
+to RISC-V Staff at `[email protected] <mailto:[email protected]>`_.

_sources/ci_hosting.rst.txt

@@ -0,0 +1,16 @@
+======================================================
+Hosting a Continuous Integration (CI) Project at a Lab
+======================================================
+
+Hosting a continuous integration project at a lab means providing RISC-V hardware or emulated compute instances as CI runners/agents for public use. CI compute instances can be integrated with version control systems such as GitHub, GitLab, etc. and can automate the build process of the source code for developers.
+
+Following version control systems currently support RISC-V CI:
+
+#. Jenkins
+#. GitLab
+
+.. toctree::
+    :hidden:
+    :maxdepth: 2
+
+    hosting_jenkins

_sources/hosting_jenkins.rst.txt

@@ -0,0 +1,63 @@
+==================================
+Hosting RISC-V CI through Jenkins
+==================================
+
+This page describes how users can host RISC-V CI via Jenkins. For hosting CI through Jenkins, follow the steps described below.
+
+Installing Jenkins
+===================
+
+Jenkins install instructions are given at `this link <https://www.jenkins.io/doc/book/installing/>`_.
+
+If you wish to build Jenkins from source, the repository is available at `<https://github.com/jenkinsci/jenkins>`_
+
+Adding RISC-V agents in Jenkins
+===============================
+
+Agents are the compute instances in Jenkins on which CI builds are run.
+Once Jenkins is installed, the next step is to add RISC-V agents in Jenkins. They are also referred to as slaves, build executors, or runners.
+
+Make sure that Jenkins Master (the compute instance on which Jenkins web server is running) is accessible by the RISC-V compute instance you wish to add as a slave.
+
+*For the sake of simplicity, it is assumed that RISC-V compute instances have Linux operating installed on them (preferably Ubuntu) and are accessible through SSH*
+
+Install prerequisites
+---------------------
+
+Compute instances need OpenJDK 17 or newer installed on them to be hosted on Jenkins.
+
+.. code::
+
+    sudo apt install openjdk-17-jdk
+
+
+Set up agent in Jenkins
+-----------------------
+
+* In the Jenkins web server, go to :code:`Build Executor Status > New Node`
+
+.. image:: assets/hosting_jenkins_1.png
+
+.. image:: assets/hosting_jenkins_2.png
+
+* Add a Node name (this will be displayed in the build executor list) and select Permanent Agent
+
+* Add a suitable description for users who will be using that compute instance
+
+.. image:: assets/hosting_jenkins_3.png
+
+* Add the number of executors (this indicates how many builds can run concurrently)
+* Change :code:`Launch method` to :code:`Launch agents via SSH` since our agent is accessible via SSH
+* In :code:`Host`, add the IP or URL which can be used to access the compute instance
+* In :code:`Credentials`, click on :code:`Add` if you have not created the credentials yet and add the credentials :code:`Kind` as :code:`Username with password` (these are the credentials which you can use to SSH to your RISC-V compute instance)
+* In :code:`Host Key Verification Strategy`, select :code:`Manually trusted key Verification strategy` and also check :code:`Require manual verification of initial connection`
+* If you access the RISC-V compute instance through a port other than 22, click on :code:`Advanced` and enter :code:`Port`
+* Leave other settings as is and click save
+
+Once the settings are saved, you will see :code:`Trust SSH Host Key` on the left bar. Click on it and grant permission to use the compute instance to the Jenkins controller.
+
+.. image:: assets/hosting_jenkins_4.png
+
+.. image:: assets/hosting_jenkins_5.png
+
+Now the Jenkins agent is added and can be used. For using Jenkins as mentioned above instance, use the name which you gave it at the start in your build pipelines of Jenkins.

_sources/index.md.txt

@@ -0,0 +1,10 @@
+# RISC-V Sample Document
+
+This is a **sample** document text.
+
+Type `make html` in the `docs` directory to build the document.
+
+The resulting HTML will be found in `build/html/` directory.
+
+For more information on using Markdown, see the
+[MyST Project documetation](https://myst-parser.readthedocs.io/en/latest/index.html)

_sources/index.rst.txt

@@ -0,0 +1,15 @@
+
+==========================================
+RISC-V Labs Best Practices Documentation
+==========================================
+
+TBD overview...
+
+Documents
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 2
+
+   becoming_eco_lab_partner
+   ci_hosting