1 | # Setting Up an SDM
|
2 |
|
3 | Running an SDM instance requires the following setup.
|
4 |
|
5 | ## Pre-requisites
|
6 |
|
7 | #### Java
|
8 |
|
9 | To build Java projects on the automation client node, you'll need:
|
10 |
|
11 | - JDK, for Maven and Checkstyle
|
12 | - Maven, with `mvn` on the path
|
13 |
|
14 | #### Node
|
15 |
|
16 | To build Node projects on the automation client node, you'll need:
|
17 |
|
18 | - `npm` - v 5.8.0 or above
|
19 | - `node`
|
20 |
|
21 | #### Kubernetes
|
22 |
|
23 | The kubernetesSoftwareDevelopmentMachine included here deploys to an Atomist sandbox kubernetes environment, using
|
24 | [k8-automation](https://github.com/atomist/k8-automation) which we run inside our cluster. You can deploy the Spring Boot
|
25 | projects created with `@atomist create spring` here, in order to try out the Kubernetes integration with the SDM.
|
26 |
|
27 |
|
28 | ## Environment Setup
|
29 |
|
30 | ### Choose a machine
|
31 | You must set environment variables to choose a machine, if you override the default.
|
32 | ```
|
33 | export MACHINE_PATH="./software-delivery-machine/machines"
|
34 | export MACHINE_NAME="cloudFoundrySoftwareDeliveryMachine"
|
35 | ```
|
36 |
|
37 | ### Local HTTP server
|
38 | To run a local HTTP server to invoke via `curl` or for smoke testing, please set the following environment variable:
|
39 |
|
40 | ```
|
41 | export LOCAL_ATOMIST_ADMIN_PASSWORD="<value>"
|
42 |
|
43 | ```
|
44 |
|
45 | #### Cloud Foundry
|
46 |
|
47 | In order to enable Pivotal Cloud Foundry deployment, the following environment variables are used.
|
48 |
|
49 | Required:
|
50 |
|
51 | - `PIVOTAL_USER`: your Pivotal Cloud Foundry user name
|
52 | - `PIVOTAL_PASSWORD`: your Pivotal Cloud Foundry password
|
53 | - `PCF_ORG`: your Pivotal Cloud Foundry organization name
|
54 | - `PCF_SPACE_STAGING`: your Pivotal Cloud Foundry staging space name within `$PCF_ORG`
|
55 | - `PCF_SPACE_PRODUCTION`: your Pivotal Cloud Foundry production space name within `$PCF_ORG`
|
56 |
|
57 | Optional:
|
58 |
|
59 | - `PIVOTAL_API`: PCF API to hit. Default if this key is not provided is Pivotal Web Services at `https://api.run.pivotal.io`. Specify a different value to deploy to your own Cloud Foundry instance.
|
60 |
|
61 |
|
62 | #### Checkstyle
|
63 |
|
64 | Checkstyle is a style-checker for Java.
|
65 | For the optional Checkstyle integration to work, set up two Checkstyle environment variables as follows:
|
66 |
|
67 | ```
|
68 | # Toggle Checkstyle usage
|
69 | export USE_CHECKSTYLE=true
|
70 |
|
71 | # Path to checkstyle JAR
|
72 | export CHECKSTYLE_PATH="/Users/rodjohnson/tools/checkstyle-8.8/checkstyle-8.8-all.jar"
|
73 | ```
|
74 |
|
75 | Get `checkstyle-8.8-all.jar` from [Checkstyle's download page](https://sourceforge.net/projects/checkstyle/files/checkstyle/8.8/).
|