Skip to content

Commit 5d2001d

Browse files
mathisonryanmathisonryan
committed
Add the trillian agent code
Add the trillian agent code
1 parent 113dcc4 commit 5d2001d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+6280
-36
lines changed

‎.dockerignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
./src/node-modules
2+
./src/docs/gen

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

‎Dockerfile‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# CI Build
2+
FROM golang:1.15.7 as builder
3+
4+
WORKDIR /trillian-agent
5+
6+
ARG GOFLAGS=""
7+
ENV GOFLAGS=$GOFLAGS
8+
ENV GO111MODULE=on
9+
10+
# Download dependencies first - this should be cacheable.
11+
COPY go.mod go.sum ./
12+
RUN go mod download
13+
14+
# Now add the local Trillian repo, which typically isn't cacheable.
15+
COPY . .
16+
# Build the server.
17+
RUN go get ./cmd/trillian-agent-server
18+
19+
# Package only executable
20+
# Make a minimal image.
21+
FROM gcr.io/distroless/base
22+
23+
COPY --from=builder /go/bin/trillian-agent-server /
24+
25+
ENTRYPOINT ["./trillian-agent-server"]

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2020 Unisys Corporation.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 65 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,93 @@
1-
#### DBoM Open Source Project Template Instructions
1+
# Trillian Agent
22

3-
1. Create a new project based on this template
4-
3. Update the README, replacing the contents below as prescribed
5-
3. Delete these instructions and everything up to the _Project Title_ from the README.
3+
The implementation of an agent that uses trillian as the storage mechanism
64

5+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
6+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
77

88

9-
# Project Title
9+
- [How to Use](#how-to-use)
10+
- [API](#api)
11+
- [Configuration](#configuration)
12+
- [Development](#development)
13+
- [Regenerate API](#regenerate-api)
14+
- [Usage](#usage)
15+
- [Deploy Trillian](#deploy-trillian)
16+
- [Create Master Channel Tree](#create-master-channel-tree)
17+
- [Helm Deployment](#helm-deployment)
18+
- [Getting Help](#getting-help)
19+
- [Getting Involved](#getting-involved)
1020

11-
**Description**:
21+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1222

13-
Put a meaningful, short, plain-language description of what
14-
this project is trying to accomplish and why it matters.
15-
Describe the problem(s) this project solves.
16-
Describe how this software can improve the lives of its audience.
23+
## How to Use
1724

18-
Other things to include:
25+
### API
1926

20-
- Link to the changelog
21-
- Links to production or demo instances
27+
Latest OpenAPI Specification for this API is available on the [api-specs repository](https://github.com/DBOMproject/api-specs/tree/master/agent)
2228

23-
**Screenshot**
29+
### Configuration
2430

25-
If the software has visual components, place a screenshot after the description
31+
| Environment Variable | Default | Description |
32+
|------------------------------|------------------|--------------------------------------------------------|
33+
| LOG_LEVEL | `info` | The verbosity of the logging |
34+
| PORT | `5000` | Port on which the agent listens |
35+
| HOST | `0.0.0.0` | The host address of the agent |
36+
| TRILLIAN_ENDPOINT | `localhost:8091` | The endpoint of the trillian server connect to |
37+
| CHANNEL_CONFIG_MAP_ID | `0` | The id of the trillian map to store the channel config |
38+
| JAEGER_ENABLED | `false` | Is jaeger tracing enabled |
39+
| JAEGER_HOST | `` | The jaeger host to send traces to |
40+
| JAEGER_SAMPLER_PARAM | `1` | The parameter to pass to the jaeger sampler |
41+
| JAEGER_SAMPLER_TYPE | `const` | The jaeger sampler type to use |
42+
| JAEGER_SERVICE_NAME | `Trillian Agent` | The name of the service passed to jaeger |
43+
| JAEGER_AGENT_SIDECAR_ENABLED | `false` | Is jaeger agent sidecar injection enabled |
2644

2745

28-
## Installation
46+
## Development
47+
### Regenerate API
48+
[go-swagger](https://github.com/go-swagger/go-swagger) was used to generate the server api
2949

30-
Detailed instructions on how to install, configure, and get the project running.
31-
This should be frequently tested to ensure reliability.
50+
**Please note: Make sure the trillian agent repository is included in your go path src folder**
3251

33-
## Configuration
52+
```
53+
swagger generate server -f {path-to-swagger} -A trillian-agent -t={path-to-trillian-repo}
54+
```
3455

35-
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
56+
**Please don't make updates to generated files as those changes will be overwritten when the server is regenerated**
3657

3758
## Usage
59+
### Deploy Trillian
60+
Find the information about to deploy trillian [here](https://github.com/google/trillian/tree/master/deployment)
3861

39-
Show users how to use the software.
40-
Be specific.
41-
Use appropriate formatting when showing code snippets.
62+
**Make sure to install the trillian map server as part of the deployment**
4263

43-
## How to test the software
64+
### Create Master Channel Tree
65+
After trillian is deployed, channel config trillian map needs to be created that the trillian agent will use to store channel configurations.
4466

45-
If the software includes automated tests, detail how to run those tests.
67+
Use the following command to create the tree and set the environmental variable the trillian agent will use
4668

69+
**Make sure to save the the map id as it will be needed for the deployment**
4770

48-
## Getting help
71+
```
72+
GRPC="8091"
73+
CHANNEL_CONFIG_MAP_ID=$(\
74+
go run github.com/google/trillian/cmd/createtree \
75+
--admin_server=:${GRPC} \
76+
--tree_type=MAP \
77+
--description='Trillian Agent Channel Config' \
78+
--display_name='TrillAgentChanConf' \
79+
--hash_strategy=CONIKS_SHA512_256) && echo ${CHANNEL_CONFIG_MAP_ID}
80+
```
81+
### Helm Deployment
4982

50-
If you have any queries on insert-project-name, feel free to reach us on any of our [communication channels](https://github.com/DBOMproject/community/blob/master/COMMUNICATION.md)
83+
Instructions for deploying the trillian-agent using helm charts can be found [here](https://github.com/DBOMproject/deployments/tree/master/charts/trillian-agent)
5184

52-
**Example**
85+
## Getting Help
5386

54-
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
87+
If you have any queries on trillian-agent, feel free to reach us on any of our [communication channels](https://github.com/DBOMproject/community/blob/master/COMMUNICATION.md)
5588

56-
## Getting involved
57-
58-
This section should detail why people should get involved and describe key areas you are
59-
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
60-
important pieces, etc.
61-
62-
General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).
89+
If you have questions, concerns, bug reports, etc, please file an issue in this repository's [issue tracker](https://github.com/DBOMproject/trillian-agent/issues).
6390

91+
## Getting Involved
6492

93+
Find instructions on how you can contribute in [CONTRIBUTING](CONTRIBUTING.md).

0 commit comments

Comments
 (0)