Home
For Software Developers
-
@@ -55,11 +54,13 @@
- Getting an account for Cloud-V -
- Setting up Jenkinsfile inside github project repository +
- Setting up cloud-v-pipeline inside github project repository
- Setting credentials for webhook
-
-
- Configuration inside GitHub repository +
- Obtaining github access token for repository + +
- Configuring repository webhook (Optional)
- Configurations inside Cloud-V @@ -172,10 +173,10 @@
- GitHub project repository with owner rights.
Pre-requisites
Getting an account for Cloud-V
-Contact us for a new account by emailing us at cloud-v@10xengineers.ai and fill out this google form.
+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
-Jenkinsfileinside github project repositoryJenkins pipeline will need a
+Jenkinsfilewritten with jenkins 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 bescripted pipelinewhich will only have stages or it can also bedeclarative pipelinewhich may also have steps inside stages.Setting up
+cloud-v-pipelineinside github project repositoryCloud-V will need a
cloud-v-pipelinewritten 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 bescripted pipelinewhich will only have stages or it can also bedeclarative pipelinewhich may also have steps inside stages.A simple scripted
Helloworldpipeline in linux is as follows:node{ @@ -189,11 +190,36 @@Setting up
Upon execution of such a pipeline, the console output can be viewed as follows.
-
Note: This jenkinsfile should remain same in all the branches and pull requests.
+Note: This cloud-v-pipeline should remain same in all the branches and pull requests.
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 GitHub credentials of 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.
-Configuration inside GitHub repository
+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.
+Obtaining github access token for repository
+Navigate to the dashboard of your github account and click on the your github profile picture on the top-right corner on dashboard.
+
+
Then click on the "Settings" from the list.
+
+
From the left option bar in Settings scroll down and click on "Developer settings".
+
+
Once there, click on "Personal access tokens", then click on "Fine-grained tokens" from the dropdown list and after that click on "Generate new token".
+
+
This will open the page for setting up new access token. Follow following steps for creating a token:
+-
+
- Give your token a meaningful name under "Token name" +
- Set expiration date in "Expiration" depending upon how long you would like your repository to be integrated with Cloud-V (think of a meaningful upper bound) +
- The "Resource owner" should be the owner of the repository who can access all kinds of settings of the repository +
- Under "Repository access", check "Only select repositories" and then select the repository for which you would like to create the token +
-
+
Under "Permissions" section, expand "Repository Permissions" and give the following two permissions:
+-
+
- "Read and write" access to "Commit statuses" (Because after the CI has run, Cloud-V will be able to set the status of the commit accordingly) +
- "Read and write" access to "Webhooks" (Read permission for the webhook is required for reading the incoming pull request. Write permission is required if you want Cloud-V to set the webhook for you instead of you going through the repository settings and setting it up) +
+
IMPORTANT NOTE: If you have decided to create a webhook yourself or have already created one, then Cloud-V will not be able to manage the settings for you, proceed to following section
+Configuring repository webhook (Optional)
+You can skip this step if you have given webhook read and write permission in your repository token settings in above step and havent configured any webhook yourself
In GitHub,
- Go to repository settings which you want to integrate for Cloud-V. @@ -211,10 +237,10 @@
- Add
Payload URLashttps://cloud-v.co:8443/ghprbhook/ - Select content type as
application/x-www-form-urlencoded - Check
Enable SSL verification
- - In the section Which events would you like to trigger this webhook? check
Let me select individual eventsand choose the events for which you want build to be triggered.
+ - In the section Which events would you like to trigger this webhook? check
Let me select individual eventsand checkPul requestsas individual events and dont check any other permission.
Configuration inside GitHub repo
Webhook settings will look something like this:
-
+
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.
-
@@ -268,7 +294,7 @@
Requirements for administrator