- Getting Started
+ - Getting Started
+ - Setting up CI
-
@@ -123,24 +141,25 @@
Pre-requisites
GitHub project repository with owner rights.
Getting an account for Cloud-V
-
Fill out this google form with all the required information for getting an account on Cloud-V.
-
After this we will get back to you with login credentials.
-
Setting up cloud-v-pipeline inside github project repository
-
Cloud-V will need a cloud-v-pipeline written with jenkinsfile pipeline syntax to start execution of tests/checks (see link). This pipeline will contain all the stages (and may be steps) of a CI/CD pipeline. This pipeline can be scripted pipeline which will only have stages or it can also be declarative pipeline which may also have steps inside stages.
-
A simple scripted Helloworld pipeline in linux is as follows:
-
-node{
- stage('*** Phase 1 ***') {
- //Using bash commands
- sh '''#!/bin/bash
- echo "Hello World !\n"
- '''
- }
-}
-
-
Upon execution of such a pipeline, the console output can be viewed as follows.
-
-
Note: This cloud-v-pipeline should remain same in all the branches and pull requests.
+
You can request Cloud-V access via Cloud-V contact-us page.
+
After requesting the account, Cloud-V team will have a meeting with you and will give you access to the platform accordingly.
+
Setting up repository with Cloud-V
+
Using Cloud-V automatic integration (beta)
+
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 here.
+
For GitHub
+
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.
+
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.
+
+- Visit this link for installing GitHub app.
+- 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
+- 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.
+- Click on "Install & Authorize" which will take you to the page where you can add repository URL
+- Add repository URL and click on "Submit"
+- The next page will show you:
+- Access Token (will be visible one-time)
+- URL of the GitHub repository which is configured (currently, one token can be configured with one repository)
+- The link of the CI pipeline which is created automatically in Cloud-V CI dashboard
+
Setting credentials for webhook
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.
This process requires access token of the repository CREATED BY OWNER OF REPOSITORY 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.
@@ -189,6 +208,22 @@
Configuring repository webhook
Webhook settings will look something like this:
+
Setting up cloud-v-pipeline inside github project repository
+
Cloud-V will need a cloud-v-pipeline written with jenkinsfile pipeline syntax to start execution of tests/checks (see link). This pipeline will contain all the stages (and may be steps) of a CI/CD pipeline. This pipeline can be scripted pipeline which will only have stages or it can also be declarative pipeline which may also have steps inside stages.
+
A simple scripted Helloworld pipeline in linux is as follows:
+
+node{
+ stage('*** Phase 1 ***') {
+ //Using bash commands
+ sh '''#!/bin/bash
+ echo "Hello World !\n"
+ '''
+ }
+}
+
+
Upon execution of such a pipeline, the console output can be viewed as follows.
+
+
Note: This cloud-v-pipeline should remain same in all the branches and pull requests.
Configurations inside Cloud-V
Note: 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.
@@ -244,7 +279,7 @@ Requirements for administrator