aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/README.md
blob: 9d8d4cc9abfc9f9254beb4f61a3d11f91c3808d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
## **Quick Start Guide**


This is a quick start guide describing how to deploy ONAP on Kubernetes using Helm.

Pre-requisites:

-  Your Kubernetes environment must be available. For more information see, [ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
-  Deployment artifacts are customized for your location.


### **Deploy ONAP Instance**

Step 1. Clone the OOM repository from ONAP gerrit:

```
> git clone http://gerrit.onap.org/r/oom
> cd oom/kubernetes
```

Step 2. Customize the oom/kubernetes/onap parent chart, like the values.yaml file, to suit your deployment. You may want to selectively enable or disable ONAP components by changing the subchart **enabled** flags to *true* or *false*.  The .yaml file for OpenStackEncryptedPassword should be the MSO ecnrypted value of the openstack tenant password
```
Example:
...
robot: # Robot Health Check
  enabled: true
sdc:
  enabled: false
sdnc:
  enabled: false
so: # Service Orchestrator
  enabled: true
...
```
Step 3. To setup a local Helm repository to serve up the local ONAP charts:
        [Note: ensure helm init has been executed on the node, or run helm init --client-only]
```
> helm serve &
```
Note the port number that is listed and use it in the Helm repo add as follows:
```
> helm repo add local http://127.0.0.1:8879
```

Step 4. Build a local Helm repository (from the kubernetes directory):
```
> make all
```

Step 5. Display the charts that are available to be deployed:
```
> helm search -l
NAME                    VERSION    DESCRIPTION
local/appc              2.0.0      Application Controller
local/clamp             2.0.0      ONAP Clamp
local/onap              2.0.0      Open Network Automation Platform (ONAP)
local/robot             2.0.0      A helm Chart for kubernetes-ONAP Robot
local/so                2.0.0      ONAP Service Orchestrator
...
```

**Note:**
Setup of this Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use **make** to update your local Helm repository.

Step 6. Once the repo is setup, installation of ONAP can be done with a single command:
```
> helm install local/onap --name dev --namespace onap
```
**Note:** the **--namespace onap** is currently required while all onap helm charts are migrated to version 2.0. After this activity is complete, namespaces will be optional.

Use the following to monitor your deployment and determine when ONAP is ready for use:
```
> kubectl get pods --all-namespaces -o=wide
```


#### **Cleanup deployed ONAP instance**

To delete a deployed instance, use the following command:
```
> helm del dev --purge
```



For more information on OOM project documentation, refer to:

 -  [Quick Start Guide on Wiki](https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project#ONAPOperationsManagerProject-QuickStartGuide)
 -  [Quick Start Guide on readthedocs](http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20Project%20Description/oom_project_description.html#quick-start-guide)
398' href='#n398'>398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
---
# Global macros

# vim: sw=2 ts=2 sts=2 et :

# BUILDERS
- builder:
    name: ci-management-check-unicode
    builders:
      - shell: |
          $WORKSPACE/scripts/check-unicode.sh jjb/

- builder:
    name: provide-maven-settings
    builders:
      - config-file-provider:
          files:
            - file-id: '{global-settings-file}'
              variable: 'GLOBAL_SETTINGS_FILE'
            - file-id: '{settings-file}'
              variable: 'SETTINGS_FILE'

# call maven-target builder with a goal of --version to force Jenkins to
# install the needed maven version
- builder:
    name: maven-install
    builders:
      - maven-target:
          maven-version: '{maven-version}'
          goals: '--version'

- builder:
    name: maven-docker-push-release
    builders:
      - maven-target:
          maven-version: '{maven-version}'
          pom: '{pom}'
          goals: 'clean deploy -B -P {mvn-profile}'
          settings: '{mvn-settings}'
          settings-type: cfp
          global-settings: 'global-settings'
          global-settings-type: cfp
          properties:
            - maven.test.skip=true
            - docker.pull.registry=nexus3.onap.org:10001
            - docker.push.registry=nexus3.onap.org:10002

- builder:
    name: maven-docker-push-daily
    builders:
      - maven-target:
          maven-version: '{maven-version}'
          pom: '{pom}'
          goals: 'clean deploy -B -P {mvn-profile}'
          settings: '{mvn-settings}'
          settings-type: cfp
          global-settings: 'global-settings'
          global-settings-type: cfp
          properties:
            - maven.test.skip=true
            - docker.pull.registry=nexus3.onap.org:10001
            - docker.push.registry=nexus3.onap.org:10003

- builder:
    name: docker-login
    builders:
      - shell: !include-raw: include-docker-login.sh

# PARAMETERS
- parameter:
    name: infra-parameters
    parameters:
      - string:
          name: PROJECT
          default: '{project}'
          # yamllint disable rule:line-length
          description: 'JJB configured PROJECT parameter to identify a Gerrit project'
          # yamllint enable
      - string:
          name: ARCHIVE_ARTIFACTS
          default: '{artifacts} **/target/surefire-reports/*-output.txt'
          # yamllint disable rule:line-length
          description: 'Space separated glob patterns for artifacts to archive to logs hosting'
          # yamllint enable
      - string:
          name: GERRIT_BRANCH
          default: '{branch}'
          description: 'JJB configured GERRIT_BRANCH parameter'
      - string:
          name: GERRIT_PROJECT
          default: '{project}'
          description: 'GERRIT_PROJECT parameter if not given by trigger'
      - string:
          name: GERRIT_REFSPEC
          default: '{refspec}'
          description: 'GERRIT_REFSPEC parameter if not given by trigger'
      - string:
          name: STACK_NAME
          default: '$JOB_NAME-$BUILD_NUMBER'
          description: 'Used by Heat to generate a unique stack & vm name'

- parameter:
    name: maven-exec
    parameters:
      - string:
          name: MVN
          # yamllint disable rule:line-length
          default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{maven-version}/bin/mvn'
          # yamllint enable
          description: 'Maven selector to be used by shell scripts'

# PROPERTIES
- property:
    name: infra-properties
    properties:
      - build-discarder:
          days-to-keep: '{build-days-to-keep}'
          num-to-keep: 40
          artifact-days-to-keep: -1
          artifact-num-to-keep: 5

# PUBLISHERS
- publisher:
    name: archive-artifacts
    publishers:
      - archive:
          artifacts: '{artifacts}'
          allow-empty: true
          fingerprint: true
          latest-only: true

- publisher:
    name: email-notification
    publishers:
      - email-ext:
          recipients: 'nobody@open-o.org'
          reply-to:
          content-type: default
          # yamllint disable rule:line-length
          subject: '{email-prefix} $PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!'
          # yamllint enable
          body: |
            $PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS:

            Check console output at $BUILD_URL to view the results.
          unstable: true
          fixed: true
          send-to:
            - developers
            - recipients

- publisher:
    name: jacoco-report
    publishers:
      - jacoco:
          exec-pattern: '**/**.exec'
          class-pattern: '**/classes'
          source-pattern: '**/src/main/java'
          # yamllint disable rule:line-length
          exclusion-pattern: '**/gen**,**/generated-sources/**,**/yang-gen**,**/pax/**'
          # yamllint enable
          status-update: true
          targets:
            - branch:
                healthy: 10
                unhealthy: 20
            - method:
                healthy: 50
                unhealthy: 40

- publisher:
    name: checkstyle-result
    publishers:
      - checkstyle:
          pattern: '**/checkstyle-result.xml'
          healthy: 0
          unhealthy: 100
          health-threshold: 'high'
          thresholds:
            unstable:
              total-all: 30
              total-high: 15
              total-normal: 20
              total-low: 25
              new-all: 5
              new-high: 0
              new-normal: 2
              new-low: 5

- publisher:
    name: checkstyle-result-daily
    publishers:
      - checkstyle:
          pattern: '**/checkstyle-result.xml'
          healthy: 0
          unhealthy: 100
          health-threshold: 'high'
          thresholds:
            unstable:
              total-all: 30
              total-high: 15
              total-normal: 20
              total-low: 25
              new-all: 1
              new-high: 0
              new-normal: 1
              new-low: 1

- publisher:
    name: infra-shiplogs
    # To archive things, the job will need to create an "archives" directory in
    # the workspace and this macro will handle copying the contents of the
    # archives directory.
    #
    # Uses the build parameter ARCHIVE_ARTIFACTS if not empty to find files to
    # archive. You can pass globstar patterns for example "**/*.xml **/*.log" as
    # the archive pattern. This is a space separated list of files to archive.
    #
    # Also ensure that the workspace is cleaned up at the end of the build.
    publishers:
      - postbuildscript:
          builders:
            - shell: !include-raw-escape: include-raw-deploy-archives.sh
            - maven-target:
                maven-version: '{maven-version}'
                pom: '.archives/deploy-archives.xml'
                goals: 'clean deploy -V -B -q -Dmaven.repo.local=/tmp/r'
                settings: 'jenkins-log-archives-settings'
                settings-type: cfp
                global-settings: 'global-settings'
                global-settings-type: cfp
            - description-setter:
                regexp: '^Build logs: .*'
          script-only-if-succeeded: false
          script-only-if-failed: false
          mark-unstable-if-failed: true
      - workspace-cleanup:
          fail-build: false`

# SCMS
- scm:
    name: git-scm
    scm:
      - git:
          credentials-id: 'onap-jenkins-ssh'
          url: '$GIT_BASE'
          refspec: ''
          branches:
            - 'origin/{branch}'
          skip-tag: true
          wipe-workspace: true
          timeout: 30

- scm:
    name: gerrit-trigger-scm
    scm:
      - git:
          credentials-id: 'onap-jenkins-ssh'
          url: '$GIT_BASE'
          refspec: '{refspec}'
          branches:
            - 'origin/$GERRIT_BRANCH'
          skip-tag: true
          timeout: 30
          choosing-strategy: '{choosing-strategy}'
          submodule:
            recursive: '{submodule-recursive}'

- scm:
    name: gerrit-trigger-scm-basedir
    scm:
      - git:
          credentials-id: 'onap-jenkins-ssh'
          url: '$GIT_BASE'
          refspec: '{refspec}'
          branches:
            - 'origin/$GERRIT_BRANCH'
          skip-tag: true
          timeout: 30
          choosing-strategy: '{choosing-strategy}'
          basedir: '{basedir}'

- scm:
    name: git-branch-scm
    scm:
      - git:
          credentials-id: 'onap-jenkins-ssh'
          url: '$GIT_BASE'
          refspec: ''
          branches:
            - 'origin/{branch}'
          skip-tag: true
          timeout: 30
          wipe-workspace: true

- scm:
    name: git-extra-project
    scm:
      - git:
          credentials-id: 'onap-jenkins-ssh'
          url: '$GIT_NO_PROJECT/{project}'
          refspec: '{refspec}'
          branches:
            - 'origin/{branch}'
          skip-tag: true
          timeoute: 30
          wipe-workspace: false
          basedir: '{checkout-dir}'

# TRIGGERS

# This is a single macro to use for all jobs who vote on every (relevant) patch
# set. Only 'recheck' trigger word is supported, it always triggers the full set
# of relevant jobs, in order to prevent Jenkins from starting only a subset and
# still voting Verified+1
# Arguments:
#     server: name of gerrit server to listen to
#     project: pattern to match triggering projects
#     branch: triggering branch name
#     files: pattern to match triggering filepaths
- trigger:
    name: gerrit-trigger-patch-submitted
    triggers:
      - gerrit:
          server-name: '{server}'
          trigger-on:
            - patchset-created-event:
                exclude-drafts: 'false'
                exclude-trivial-rebase: 'false'
                exclude-no-code-change: 'false'
            - draft-published-event
            - comment-added-contains-event:
                comment-contains-value: 'recheck'
          projects:
            - project-compare-type: 'ANT'
              project-pattern: '{project}'
              branches:
                - branch-compare-type: 'ANT'
                  branch-pattern: '**/{branch}'
              file-paths:
                - compare-type: 'ANT'
                  pattern: '{files}'

- trigger:
    name: gerrit-trigger-patch-merged
    triggers:
      - gerrit:
          server-name: '{server}'
          trigger-on:
            - change-merged-event
            - comment-added-contains-event:
                comment-contains-value: 'remerge'
          projects:
            - project-compare-type: 'ANT'
              project-pattern: '{project}'
              branches:
                - branch-compare-type: 'ANT'
                  branch-pattern: '**/{branch}'
              file-paths:
                - compare-type: 'ANT'
                  pattern: '{files}'

- trigger:
    name: gerrit-trigger-release-manually
    triggers:
      - gerrit:
          server-name: '{server}'
          trigger-on:
            - comment-added-contains-event:
                comment-contains-value: 'please release'
          projects:
            - project-compare-type: 'ANT'
              project-pattern: '{project}'
              branches:
                - branch-compare-type: 'ANT'
                  branch-pattern: '**/{branch}'
              file-paths:
                - compare-type: 'ANT'
                  pattern: '**'

- trigger:
    name: trigger-on-build-success
    triggers:
      - reverse:
          jobs: '{job-name}'
          result: 'success'


# WRAPPERS
- wrapper:
    name: build-timeout
    wrappers:
      - timeout:
          type: absolute
          timeout: 360
          fail: true

- wrapper:
    # This wrapper is required for all jobs as it configures the wrappers
    # needed by the eCOMP infra.
    name: infra-wrappers
    wrappers:
      - timestamps
      - timeout:
          type: absolute
          timeout: '{build-timeout}'
          timeout-var: 'BUILD_TIMEOUT'
          fail: true
      - ssh-agent-credentials:
          users:
            - 'onap-jenkins-ssh'
      - openstack:
          single-use: true