mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
Merge pull request #728 from rodibrin/reviewdoc
Project Piper Documentation - Guided Tour
This commit is contained in:
rodibrin
GitHub
commit
c138504147
104
README.md
104
README.md
@ -2,98 +2,17 @@
|
||||
[](https://codeclimate.com/github/SAP/jenkins-library/maintainability)
|
||||
[](https://codeclimate.com/github/SAP/jenkins-library/test_coverage)
|
||||
|
||||
# Description
|
||||
# Project Piper Repository
|
||||
|
||||
An efficient software development process is vital for success in building
|
||||
business applications on SAP Cloud Platform or SAP on-premise platforms. SAP
|
||||
addresses this need for efficiency with project "Piper". The goal of project
|
||||
"Piper" is to substantially ease setting up continuous delivery processes for
|
||||
the most important SAP technologies by means of Jenkins pipelines.
|
||||
The Project "Piper" offers default pipelines to easily implement CI/CD processes integrating SAP systems. The corresponding "Shared Library" provides a set of "steps" to build your own scenarios beyond defaults.
|
||||
|
||||
Project "Piper" consists of two parts:
|
||||
# User Documentation
|
||||
|
||||
* [A shared library][piper-library] containing steps and utilities that are
|
||||
required by Jenkins pipelines.
|
||||
* A set of [Docker images][devops-docker-images] used in the piper library to implement best practices.
|
||||
|
||||
Please follow [this link to our extended library documentation][piper-library-pages].
|
||||
|
||||
## What you get
|
||||
|
||||
The shared library contains all the necessary steps to run our best practice
|
||||
[Jenkins pipelines][piper-library-pages] described in the Scenarios section or
|
||||
to run a [pipeline as step][piper-library-scenario].
|
||||
|
||||
The best practice pipelines are based on the general concepts of [Jenkins 2.0
|
||||
Pipelines as Code][jenkins-doc-pipelines]. With that you have the power of the
|
||||
Jenkins community at hand to optimize your pipelines.
|
||||
|
||||
You can run the best practice Jenkins pipelines out of the box, take them as a
|
||||
starting point for project-specific adaptations or implement your own pipelines
|
||||
from scratch using the shared library.
|
||||
|
||||
## Extensibility
|
||||
|
||||
If you consider adding additional capabilities to your `Jenkinsfile`, consult
|
||||
the [Jenkins Pipeline Steps Reference][jenkins-doc-steps]. There, you get an
|
||||
overview about steps that are natively supported by Jenkins.
|
||||
|
||||
The [Jenkins shared libraries][jenkins-doc-libraries] concept helps you to
|
||||
extract reusable parts from your pipeline and to keep your pipeline code small
|
||||
and easy to maintain.
|
||||
|
||||
Custom library steps can be added using a custom library according to the
|
||||
[Jenkins shared libraries][jenkins-doc-libraries] concept instead of adding
|
||||
groovy coding to the `Jenkinsfile`. Your custom library can coexist next to the
|
||||
provided pipeline library.
|
||||
|
||||
## API
|
||||
|
||||
All steps (`vars` and `resources` directory) are intended to be used by Pipelines and are considered API.
|
||||
All the classes / groovy-scripts contained in the `src` folder are by default not part of
|
||||
the API and are subjected to change without prior notice. Types and methods annotated with
|
||||
`@API` are considered to be API, used e.g. from other shared libraries. Changes to those
|
||||
methods/types needs to be announced, discussed and agreed.
|
||||
|
||||
# Requirements
|
||||
|
||||
* Java Runtime Environment 8
|
||||
* Installation of Jenkins v 2.60.3 or higher running on Linux. We tested with
|
||||
debian-stretch.
|
||||
* Jenkins Plugins installed as described in the [Required
|
||||
Plugin][piper-library-pages-plugins] section.
|
||||
* A Jenkins user with administration privileges.
|
||||
* The Jenkins instance has access to [github.com][github].
|
||||
|
||||
# Download and Installation
|
||||
|
||||
To setup the shared library, you need to perform the following steps:
|
||||
|
||||
1. Login to your Jenkins instance with administration privileges.
|
||||
1. Open the system configuration page (*Manage Jenkins > Configure System*).
|
||||
1. Scroll down to section *Global Pipeline Libraries* and add a new Library by clicking the *Add* button.
|
||||
1. set *Library Name* to `piper-lib-os`
|
||||
1. set *Default Version* to the branch or tag you want to consume (e.g. `master` or `v0.1`)
|
||||
1. set *Retrieval Method* to `Modern SCM`
|
||||
1. set *Source Code Management* to `Git`
|
||||
1. set *Project Repository* to `https://github.com/SAP/jenkins-library`
|
||||
1. Save changes
|
||||
|
||||
|
||||
|
||||
Now the library is available as `piper-lib-os` and can be used in any
|
||||
`Jenkinsfile` by adding this line:
|
||||
|
||||
```groovy
|
||||
@Library('piper-lib-os') _
|
||||
```
|
||||
|
||||
Jenkins will download the library during execution of the `Jenkinsfile`.
|
||||
If you want to view the User Documentation of Project Piper please follow this [Piper Pages Link][piper-library-user-doc].
|
||||
|
||||
# Known Issues
|
||||
|
||||
A list of known issues is available on the [GitHub issues page of this
|
||||
project][piper-library-issues].
|
||||
A list of known issues is available on the [GitHub issues page of this project][piper-library-issues].
|
||||
|
||||
# How to obtain support
|
||||
|
||||
@ -109,21 +28,12 @@ before opening a pull request.
|
||||
|
||||
# License
|
||||
|
||||
Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved.
|
||||
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
|
||||
This file is licensed under the Apache Software License, v. 2 except as noted
|
||||
otherwise in the [LICENSE file][piper-library-license]
|
||||
|
||||
[github]: https://github.com
|
||||
[piper-library]: https://github.com/SAP/jenkins-library
|
||||
[devops-docker-images]: https://github.com/SAP/devops-docker-images
|
||||
[piper-library-scenario]: https://sap.github.io/jenkins-library/scenarios/ui5-sap-cp/Readme/
|
||||
[piper-library-pages]: https://sap.github.io/jenkins-library
|
||||
[piper-library-pages-plugins]: https://sap.github.io/jenkins-library/jenkins/requiredPlugins
|
||||
[piper-library-user-doc]: https://sap.github.io/jenkins-library/
|
||||
[piper-library-issues]: https://github.com/SAP/jenkins-library/issues
|
||||
[piper-library-license]: ./LICENSE
|
||||
[piper-library-contribution]: .github/CONTRIBUTING.md
|
||||
[jenkins-doc-pipelines]: https://jenkins.io/solutions/pipeline
|
||||
[jenkins-doc-libraries]: https://jenkins.io/doc/book/pipeline/shared-libraries
|
||||
[jenkins-doc-steps]: https://jenkins.io/doc/pipeline/steps
|
||||
[jenkins-plugin-sharedlibs]: https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Shared+Groovy+Libraries+Plugin
|
||||
[google-group]: https://groups.google.com/forum/#!forum/project-piper
|
||||
|
||||
201
documentation/docs/guidedtour.md
Normal file
201
documentation/docs/guidedtour.md
Normal file
@ -0,0 +1,201 @@
|
||||
# Getting Started with Project "Piper"
|
||||
|
||||
Follow this guided tour to become familiar with the basics of using project "Piper".
|
||||
|
||||
The public sample application [cloud-cf-helloworld-nodejs][cloud-cf-helloworld-nodejs] will be enriched with a pipeline which syncs the sources, builds these as MTA and deploys the result into a Cloud Foundry environment. The application contains a simple `nodejs` application. Deployed as web service, it serves static data.
|
||||
|
||||
**Recommendation:** We recommend to clone the sample application [cloud-cf-helloworld-nodejs][cloud-cf-helloworld-nodejs] and execute the instructions on your own repository. See **(Optional) Sample Application**.
|
||||
|
||||
The stated instructions assume the use of this application.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* You have installed a Linux system with at least 4 GB memory. **Note:** We have tested our samples on Ubuntu 16.04. On Microsoft Windows, you might face some issues.
|
||||
* You have installed the newest version of Docker. See [Docker Community Edition](https://docs.docker.com/install/). **Note:** we have tested on Docker 18.09.6.
|
||||
* You have installed Jenkins 2.60.3 or higher. **Recommendation:** We recommend to use the `cx-server` toolkit. See **(Optional) Install the `cx-server` Toolkit for Jenkins**. **Note:** If you use your **own Jenkins installation** you need to care for "Piper" specific configuration. Follow [my own Jenkins installation][guidedtour-my-own-jenkins].
|
||||
* Your system has access to [GitHub.com][github].
|
||||
|
||||
## (Optional) Install the `cx-server` Toolkit for Jenkins
|
||||
|
||||
`cx-server`is a lifecycle management toolkit that provides Docker images with a preconfigured Jenkins and a Nexus-based cache to facilitate the configuration and usage of Jenkins.
|
||||
|
||||
To use the toolkit, get the `cx-server` script and its configuration file `server.cfg` by using the following command:
|
||||
|
||||
```sh
|
||||
docker run -it --rm -u $(id -u):$(id -g) -v "${PWD}":/cx-server/mount/ ppiper/cx-server-companion:latest init-cx-server
|
||||
```
|
||||
|
||||
When the files are downloaded into the current directory, launch the Jenkins server by using the following command:
|
||||
|
||||
```sh
|
||||
./cx-server start
|
||||
```
|
||||
|
||||
For more information on the Jenkins lifecycle management and how to customize your Jenkins, have a look at the [Operations Guide for Cx Server][devops-docker-images-cxs-guide].
|
||||
|
||||
## (Optional) Sample Application
|
||||
|
||||
Copy the sources of the application into your own Git repository. While we will ask you to fork the application's repository into a **GitHub** space, you can use any version control system based on Git like **GitLab** or **plain git**. **Note:** A `public` GitHub repository is visible to the public. The configuration files may contain data you don't want to expose, so use a `private` repository.
|
||||
|
||||
1. Create an organization on GitHub, if you haven't any yet. See [Creating a new organization][github-create-org].
|
||||
1. [Duplicate][github-duplicate-repo] the repository [cloud-cf-helloworld-nodejs][cloud-cf-helloworld-nodejs] into your GitHub organization. [Make this repository private][github-set-repo-visible]. **Note:** Forked public repositories cannot be made private.
|
||||
1. Get an account and space in the Cloud Foundry environment. For the deployment of the application you need access to a space on the Cloud Foundry environment of the SAP Cloud Platform. If you haven't any yet, get a [Trial Account][sap-cp-trial].
|
||||
1. Select the `1_REST_persist_in_Memory` branch of your [cloud-cf-helloworld-nodejs] fork. Other branches might work as well, but this one is tested.
|
||||
|
||||
## Create Your First Pipeline
|
||||
|
||||
1. Get your application repository in place.
|
||||
1. Create a new file with the name `Jenkinsfile` in the root level of your repository and enter the following code:
|
||||
```
|
||||
@Library('piper-lib-os') _
|
||||
node() {
|
||||
stage('prepare') {
|
||||
checkout scm
|
||||
setupCommonPipelineEnvironment script:this
|
||||
}
|
||||
}
|
||||
```
|
||||
The "prepare" step synchronizes the repository and initializes the project specific settings. For more information about Jenkinsfiles and pipelines, see [Using a Jenkinsfile][jenkins-io-jenkinsfile].
|
||||
|
||||
1. Save your changes to your remote repository.
|
||||
|
||||
1. To set up a Jenkins job for your repository, open the Jenkins UI under `http://<jenkins-server-address>:<http-port>` and choose **New Item**. Per default, the `cx-server` starts Jenkins on HTTP port `80`. For more information, see the [Jenkins User Documentation][jenkins-io-documentation].
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
1. Provide a name for your new item (for example, *My First Pipeline*) and select **Pipeline**.
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
1. For **Definition** in the **Pipeline** options, choose **Pipeline script from SCM**.
|
||||
|
||||
1. For **SCM**, choose **Git**.
|
||||
|
||||
1. For **Repository URL** in the **Repositories** section, enter the URL of your Git repository, for example `https://github.com/<your-org>/cloud-cf-helloworld-nodejs`. **Note:** If your repository is protected, you must provide your credentials in the **Credentials** section.
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
1. For **Branch Specifier** in the **Branches to build** section, enter the branch name `*/1_REST_persist_in_Memory`.
|
||||
|
||||
1. Choose **Save**.
|
||||
|
||||
1. To run your pipeline, choose **Build Now** in the job UI. **Result:** The pipeline processed the single stage "prepare".
|
||||
|
||||
|
||||
## Add a Build Step
|
||||
|
||||
1. In your `Jenkinsfile`, add the following code snippet:
|
||||
```
|
||||
stage('build') {
|
||||
mtaBuild script: this
|
||||
}
|
||||
```
|
||||
The `mtaBuild` step calls a build tool to build a multi-target application (MTA). The tool consumes an MTA descriptor that contains the metadata of all entities which comprise an application or are used by one during deployment or runtime, and the dependencies between them. For more information about MTAs, see [sap.com][sap].
|
||||
|
||||
1. Create the MTA descriptor file with the name `mta.yaml` in the root level of the repository. Insert the following code:
|
||||
```
|
||||
_schema-version: 2.1.0
|
||||
ID: com.sap.piper.node.hello.world
|
||||
version: 1.0.0
|
||||
description: A Hello World sample application
|
||||
provider: SAP Sample generator
|
||||
modules:
|
||||
- name: piper.node.hello.world
|
||||
type: nodejs
|
||||
path: .
|
||||
```
|
||||
|
||||
1. Configure the step to build an MTA for the Cloud Foundry environment. Create the configuration file `.pipeline/config.yml` relative to the root level of the repository and insert the following content:
|
||||
```
|
||||
general:
|
||||
steps:
|
||||
mtaBuild:
|
||||
buildTarget: 'CF'
|
||||
```
|
||||
For additional information about the configuration, have a look at the [Common Configuration Guide][resources-configuration] and the [MTA build step documentation][resources-step-mtabuild].
|
||||
|
||||
1. Save your changes to your remote repository.
|
||||
|
||||
1. To run your pipeline, choose **Build Now** in the job UI. **Result:** The pipeline processed two stages, the "prepare" and the "build".
|
||||
|
||||
## Add a Deploy Step
|
||||
|
||||
1. In your `Jenkinsfile`, add the following code snippet:
|
||||
```
|
||||
stage('deploy') {
|
||||
cloudFoundryDeploy script: this
|
||||
}
|
||||
```
|
||||
The `cloudFoundryDeploy` step calls the Cloud Foundry command line client to deploy the built MTA into SAP Cloud Platform.
|
||||
|
||||
1. To configure the step to deploy into the Cloud Foundry environment, in your repository, open the `.pipeline/config.yml` and add the following content:
|
||||
```
|
||||
cloudFoundryDeploy:
|
||||
deployTool: 'mtaDeployPlugin'
|
||||
deployType: 'standard'
|
||||
cloudFoundry:
|
||||
org: '<your-organisation>'
|
||||
space: '<your-space>'
|
||||
credentialsId: 'CF_CREDENTIALSID'
|
||||
```
|
||||
**Note:** look after the indentation of the step within the YAML. Specify the `organisation` and `space` properties. For more information about the configuration, see the [Common Configuration Guide][resources-configuration] and [cloudFoundryDeploy][resources-step-cloudFoundryDeploy].
|
||||
1. The key `CF_CREDENTIALSID` refers to a user-password credential you must create in Jenkins: In Jenkins, choose **Credentials** from the main menu and add a **Username with Password** entry.
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
1. Save the Credential
|
||||
|
||||
1. Save your changes to your remote repository.
|
||||
|
||||
1. To run your pipeline, choose **Build Now** in the job UI. **Result:** The pipeline processed the three stages "prepare", "build" and "deploy".
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
If your pipeline fails, compare its files to the final [Jenkinsfile][guidedtour-sample.jenkins], the [config.yml][guidedtour-sample.config], and the [mta.yaml][guidedtour-sample.mta]. **Note**: YAML files are surprisingly sensitive regarding indentation.
|
||||
|
||||
## Open Application
|
||||
|
||||
Your application has been deployed into your space in the Cloud Foundry space on SAP Cloud Platform. Login to SAP Cloud Platform and navigate into you space. **Result:** Your space contains the application `piper.node.hello.world`, the state of the application is `Started`.
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
Open the application name to get into the `Application Overview`. Open the **Application Route** and add `/users` to the URL. **Result:** The application returns a list of user data.
|
||||
|
||||
## What's Next
|
||||
|
||||
You are now familiar with the basics of using project "Piper". Through the concept of pipeline as code, project "Piper" and Jenkins pipelines are extremely powerful. While Jenkins pipelines offer a full set of common programming features, project "Piper" adds SAP-specific flavors. Have a look at the different **Scenarios** to understand how to easily integrate SAP systems with default pipelines. Browse the steadily increasing list of features you can implement through the project "Piper" **Steps**.
|
||||
|
||||
The **Configuration** pattern supports simple pipelines that can be reused by multiple applications. To understand the principles of inheritance and customization, have a look at the the [configuration][resources-configuration] documentation.
|
||||
|
||||
Please also consult the blog post on setting up [Continuous Delivery for S/4HANA extensions][sap-blog-ci-cd] and get tons of informations around the application development with the [S/4HANA Cloud SDK][sap-blog-s4-sdk-first-steps].
|
||||
|
||||
|
||||
[guidedtour-my-own-jenkins]: myownjenkins.md
|
||||
[guidedtour-sample.config]: samples/cloud-cf-helloworld-nodejs/pipeline/config.yml
|
||||
[guidedtour-sample.jenkins]: samples/cloud-cf-helloworld-nodejs/Jenkinsfile
|
||||
[guidedtour-sample.mta]: samples/cloud-cf-helloworld-nodejs/mta.yaml
|
||||
[resources-configuration]: configuration.md
|
||||
[resources-step-mtabuild]: steps/mtaBuild.md
|
||||
[resources-step-cloudFoundryDeploy]: steps/cloudFoundryDeploy.md
|
||||
|
||||
[sap]: https://www.sap.com
|
||||
[sap-cp-trial]: https://account.hanatrial.ondemand.com
|
||||
[sap-blog-s4-sdk-first-steps]: https://blogs.sap.com/2017/05/10/first-steps-with-sap-s4hana-cloud-sdk/
|
||||
[sap-blog-ci-cd]: https://blogs.sap.com/2017/09/20/continuous-integration-and-delivery/
|
||||
|
||||
[devops-docker-images-cxs-guide]: https://github.com/SAP/devops-docker-images/blob/master/docs/operations/cx-server-operations-guide.md
|
||||
|
||||
[cloud-cf-helloworld-nodejs]: https://github.com/SAP/cloud-cf-helloworld-nodejs
|
||||
[github]: https://github.com
|
||||
[jenkins-io-documentation]: https://jenkins.io/doc/
|
||||
[jenkins-io-jenkinsfile]: https://jenkins.io/doc/book/pipeline/jenkinsfile
|
||||
|
||||
[github-create-org]: https://help.github.com/en/articles/creating-a-new-organization-from-scratch
|
||||
[github-duplicate-repo]: [https://help.github.com/en/articles/duplicating-a-repository]
|
||||
[github-set-repo-visible]: [https://help.github.com/en/articles/setting-repository-visibility]
|
||||
BIN
documentation/docs/images/JenkinsCredentials-1.png
Normal file
BIN
documentation/docs/images/JenkinsCredentials-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
documentation/docs/images/JenkinsHomeMenu-1.png
Normal file
BIN
documentation/docs/images/JenkinsHomeMenu-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
documentation/docs/images/JenkinsNewItemPipeline-1.png
Normal file
BIN
documentation/docs/images/JenkinsNewItemPipeline-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
BIN
documentation/docs/images/JenkinsNewItemPipeline-2.png
Normal file
BIN
documentation/docs/images/JenkinsNewItemPipeline-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
BIN
documentation/docs/images/JenkinsPipelineJob.png
Normal file
BIN
documentation/docs/images/JenkinsPipelineJob.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
documentation/docs/images/SCPDeployApp-1.png
Normal file
BIN
documentation/docs/images/SCPDeployApp-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
documentation/docs/images/SCPDeployApp-3.png
Normal file
BIN
documentation/docs/images/SCPDeployApp-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
@ -1,12 +1,67 @@
|
||||
# Project "Piper" - extended library documentation
|
||||
# Project "Piper" User Documentation
|
||||
|
||||
On the following pages, you can find documentation for all steps and scripts
|
||||
contained in the library of project "Piper".
|
||||
An efficient software development process is vital for success in building
|
||||
business applications on SAP Cloud Platform or SAP on-premise platforms. SAP
|
||||
addresses this need for efficiency with project "Piper". The goal of project
|
||||
"Piper" is to substantially ease setting up continuous delivery processes for
|
||||
the most important SAP technologies by means of Jenkins pipelines.
|
||||
|
||||
We have also compiled a list of plugins that are required for the library to
|
||||
work.
|
||||
## What you get
|
||||
|
||||
For information on the project and installation of the library, please have a
|
||||
look at our [README.md][piper-pipelines-readme].
|
||||
Project "Piper" consists of two parts:
|
||||
|
||||
[piper-pipelines-readme]: https://github.com/SAP/jenkins-library/blob/master/README.md
|
||||
* [A shared library][piper-library] containing steps and utilities that are
|
||||
required by Jenkins pipelines.
|
||||
* A set of [Docker images][devops-docker-images] used in the piper library to implement best practices.
|
||||
|
||||
The shared library contains all the necessary steps to run our best practice
|
||||
[Jenkins pipelines][piper-library-pages] described in the Scenarios section or
|
||||
to run a [pipeline as step][piper-library-scenario].
|
||||
|
||||
The best practice pipelines are based on the general concepts of [Jenkins 2.0
|
||||
Pipelines as Code][jenkins-doc-pipelines]. With that you have the power of the
|
||||
Jenkins community at hand to optimize your pipelines.
|
||||
|
||||
You can run the best practice Jenkins pipelines out of the box, take them as a
|
||||
starting point for project-specific adaptations or implement your own pipelines
|
||||
from scratch using the shared library.
|
||||
|
||||
## Extensibility
|
||||
|
||||
If you consider adding additional capabilities to your `Jenkinsfile`, consult
|
||||
the [Jenkins Pipeline Steps Reference][jenkins-doc-steps]. There, you get an
|
||||
overview about steps that are natively supported by Jenkins.
|
||||
|
||||
The [Jenkins shared libraries][jenkins-doc-libraries] concept helps you to
|
||||
extract reusable parts from your pipeline and to keep your pipeline code small
|
||||
and easy to maintain.
|
||||
|
||||
Custom library steps can be added using a custom library according to the
|
||||
[Jenkins shared libraries][jenkins-doc-libraries] concept instead of adding
|
||||
groovy coding to the `Jenkinsfile`. Your custom library can coexist next to the
|
||||
provided pipeline library.
|
||||
|
||||
## API
|
||||
|
||||
All steps (`vars` and `resources` directory) are intended to be used by Pipelines and are considered API.
|
||||
All the classes / groovy-scripts contained in the `src` folder are by default not part of
|
||||
the API and are subjected to change without prior notice. Types and methods annotated with
|
||||
`@API` are considered to be API, used e.g. from other shared libraries. Changes to those
|
||||
methods/types needs to be announced, discussed and agreed.
|
||||
|
||||
[github]: https://github.com
|
||||
[piper-library]: https://github.com/SAP/jenkins-library
|
||||
[devops-docker-images]: https://github.com/SAP/devops-docker-images
|
||||
[devops-docker-images-issues]: https://github.com/SAP/devops-docker-images/issues
|
||||
[devops-docker-images-cxs-guide]: https://github.com/SAP/devops-docker-images/blob/master/docs/operations/cx-server-operations-guide.md
|
||||
[piper-library-scenario]: https://sap.github.io/jenkins-library/scenarios/ui5-sap-cp/Readme/
|
||||
[piper-library-pages]: https://sap.github.io/jenkins-library
|
||||
[piper-library-pages-plugins]: https://sap.github.io/jenkins-library/jenkins/requiredPlugins
|
||||
[piper-library-issues]: https://github.com/SAP/jenkins-library/issues
|
||||
[piper-library-license]: ./LICENSE
|
||||
[piper-library-contribution]: .github/CONTRIBUTING.md
|
||||
[jenkins-doc-pipelines]: https://jenkins.io/solutions/pipeline
|
||||
[jenkins-doc-libraries]: https://jenkins.io/doc/book/pipeline/shared-libraries
|
||||
[jenkins-doc-steps]: https://jenkins.io/doc/pipeline/steps
|
||||
[jenkins-plugin-sharedlibs]: https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Shared+Groovy+Libraries+Plugin
|
||||
[google-group]: https://groups.google.com/forum/#!forum/project-piper
|
||||
|
||||
51
documentation/docs/myownjenkins.md
Normal file
51
documentation/docs/myownjenkins.md
Normal file
@ -0,0 +1,51 @@
|
||||
# My own Jenkins
|
||||
|
||||
**Note:** This guide is not sufficient yet, to setup a Jenkins for project "Piper".
|
||||
|
||||
## Requirements
|
||||
|
||||
* Java Runtime Environment 8
|
||||
* Installation of Jenkins v 2.60.3 or higher running on Linux. We tested with debian-stretch.
|
||||
* Jenkins Plugins installed as described in the [Required Plugin][piper-library-pages-plugins] section.
|
||||
* A Jenkins user with administration privileges.
|
||||
* The Jenkins instance has access to [github.com][github].
|
||||
|
||||
## Download and Installation
|
||||
|
||||
To setup the shared library, you need to perform the following steps:
|
||||
|
||||
1. Login to your Jenkins instance with administration privileges.
|
||||
1. Open the system configuration page (*Manage Jenkins > Configure System*).
|
||||
1. Scroll down to section *Global Pipeline Libraries* and add a new Library by clicking the *Add* button.
|
||||
1. set *Library Name* to `piper-lib-os`
|
||||
1. set *Default Version* to the branch or tag you want to consume (e.g. `master` or `v0.1`)
|
||||
1. set *Retrieval Method* to `Modern SCM`
|
||||
1. set *Source Code Management* to `Git`
|
||||
1. set *Project Repository* to `https://github.com/SAP/jenkins-library`
|
||||
1. Save changes
|
||||
|
||||
|
||||
|
||||
Now the library is available as `piper-lib-os` and can be used in any
|
||||
`Jenkinsfile` by adding this line:
|
||||
|
||||
```groovy
|
||||
@Library('piper-lib-os') _
|
||||
```
|
||||
|
||||
Jenkins will download the library during execution of the `Jenkinsfile`.
|
||||
|
||||
[github]: https://github.com
|
||||
[piper-library]: https://github.com/SAP/jenkins-library
|
||||
[devops-docker-images]: https://github.com/SAP/devops-docker-images
|
||||
[piper-library-scenario]: https://sap.github.io/jenkins-library/scenarios/ui5-sap-cp/Readme/
|
||||
[piper-library-pages]: https://sap.github.io/jenkins-library
|
||||
[piper-library-pages-plugins]: https://sap.github.io/jenkins-library/jenkins/requiredPlugins
|
||||
[piper-library-issues]: https://github.com/SAP/jenkins-library/issues
|
||||
[piper-library-license]: ./LICENSE
|
||||
[piper-library-contribution]: .github/CONTRIBUTING.md
|
||||
[jenkins-doc-pipelines]: https://jenkins.io/solutions/pipeline
|
||||
[jenkins-doc-libraries]: https://jenkins.io/doc/book/pipeline/shared-libraries
|
||||
[jenkins-doc-steps]: https://jenkins.io/doc/pipeline/steps
|
||||
[jenkins-plugin-sharedlibs]: https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Shared+Groovy+Libraries+Plugin
|
||||
[google-group]: https://groups.google.com/forum/#!forum/project-piper
|
||||
17
documentation/docs/samples/cloud-cf-helloworld-nodejs/Jenkinsfile
vendored
Normal file
17
documentation/docs/samples/cloud-cf-helloworld-nodejs/Jenkinsfile
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
@Library('piper-lib-os') _
|
||||
|
||||
node() {
|
||||
|
||||
stage('prepare') {
|
||||
checkout scm
|
||||
setupCommonPipelineEnvironment script:this
|
||||
}
|
||||
|
||||
stage('build') {
|
||||
mtaBuild script: this
|
||||
}
|
||||
|
||||
stage('deploy') {
|
||||
cloudFoundryDeploy script: this
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
_schema-version: 2.1.0
|
||||
ID: com.sap.piper.node.hello.world
|
||||
version: 1.0.0
|
||||
description: A Hello World sample application
|
||||
provider: SAP Sample generator
|
||||
|
||||
modules:
|
||||
- name: piper.node.hello.world
|
||||
type: nodejs
|
||||
path: .
|
||||
@ -0,0 +1,11 @@
|
||||
general:
|
||||
steps:
|
||||
mtaBuild:
|
||||
buildTarget: 'CF'
|
||||
cloudFoundryDeploy:
|
||||
deployTool: 'mtaDeployPlugin'
|
||||
deployType: 'standard'
|
||||
cloudFoundry:
|
||||
org: '<your-organisation>'
|
||||
space: '<your-space>'
|
||||
credentialsId: 'CF_CREDENTIALSID'
|
||||
@ -29,8 +29,8 @@ While using a custom docker file, ensure that the following tools are installed:
|
||||
## Example
|
||||
|
||||
```groovy
|
||||
def mtarFileName
|
||||
dir('/path/to/FioriApp'){
|
||||
mtarFileName = mtaBuild script:this, buildTarget: 'NEO'
|
||||
mtaBuild script:this, buildTarget: 'NEO'
|
||||
}
|
||||
def mtarFilePath = commonPipelineEnvironment.getMtarFilePath()
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
site_name: Jenkins 2.0 Pipelines
|
||||
nav:
|
||||
- Home: index.md
|
||||
- 'Guided Tour' : guidedtour.md
|
||||
- Configuration: configuration.md
|
||||
- 'Library steps':
|
||||
- artifactSetVersion: steps/artifactSetVersion.md
|
||||
@ -49,7 +50,8 @@ nav:
|
||||
- 'Build and Deploy Hybrid Applications with Jenkins and SAP Solution Manager': scenarios/changeManagement.md
|
||||
- 'Build and Deploy SAP UI5 or SAP Fiori Applications on SAP Cloud Platform with Jenkins': scenarios/ui5-sap-cp/Readme.md
|
||||
- 'Build and Deploy Applications with Jenkins and the SAP Cloud Application Programming Model': scenarios/CAP_Scenario.md
|
||||
- 'Required Plugins': jenkins/requiredPlugins.md
|
||||
- Resources:
|
||||
- 'Required Plugins': jenkins/requiredPlugins.md
|
||||
|
||||
theme:
|
||||
name: 'material'
|
||||
|
||||
Loading…
Reference in New Issue
Block a user