summaryrefslogtreecommitdiffstats
path: root/certService/README.md
blob: db96fa98661586015935c05ac222ef83ca779ff5 (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# Cert service

### For developers
    * AAF Cert Service is a Spring Boot application
    * Code style
        Use Google code formatter in your IDE.
        For IntelliJ use [https://plugins.jetbrains.com/plugin/8527-google-java-format]
        For other IDEs use []https://github.com/google/google-java-format]

### Running Locally
    ```
     mvn spring-boot:run

    ```

### Project building
    ```
     mvn clean package

    ```
    
### Building Docker image manually
    ```
    docker build -t cert-service .

    ```
    
### Install the package into the local repository
    ```
    mvn clean install
   
    ```     
    
### Building Docker image and  install the package into the local repository
    ```
    mvn clean install -P docker
   
    ```   

### Running Docker container
    ```
    docker run -p 8080:8080 --name cert-service cert-service

    ```

### Health Check
 Browser:
 
    ```
     http://<localhost>:8080/actuator/health
     
    ```
     
 Curl:   
 
    ```
     curl localhost:8080/actuator/health 
     
    ```   
 Should return {"status":"UP"}

### Running CSITs
Pull csit repository
    
    ```
     https://gerrit.onap.org/r/admin/repos/integration/csit
    
    ```
Go to created directory and run
    
    ```
     sudo ./run-csit.sh plans/aaf/cert-service
    
    ```
### Logs locally

path: 

    ```
     var/log/onap/aaf/certservice/
    ```    
### Logs in Docker container
    ```
     docker exec -it cert-service bash
    ```

path:

    ```
      cd /var/log/onap/aaf/certservice
    ```
You should see:    
audit.log  error.log  trace.log

### Sonar results
    ```     
      https://sonarcloud.io/dashboard?id=onap_aaf-certservice
    ```

### RestAPI
API is described by Swagger ( OpenAPI 3.0 ) on endpoint /docs 
( endpoint is defined in properties as springdoc.swagger-ui.path )
  
    ```
    http://localchost:8080/docs
    
    ```

### Sonar results
    ```     
      https://sonarcloud.io/dashboard?id=onap_aaf-certservice
    ```