Skip to content

Commit 9af617b

Browse files
vchaindzvchaindz
authored
Updated Readme and Dockerfiles for the 0.6.0 release candidate
* add ACKNOWLEDGEMENTS * change ACKNOWLEDGEMENTS * new debian package tools and bm * OSS List * OSS List updated * OSS update * new Dockerfiles and Readme update * Readme update * Readme update * Readme update * Readme update quickstart * Readme update api docu and diagrams * Readme fix diagrams * fix immudb-consistency-diagram.png * fix README API * add screenshots * fix diagram * fix Dockerfile * add immugw api to Readme * add kill commands to Readme * add MacOS to Readme
1 parent 7387ca6 commit 9af617b

12 files changed

+707
-98
lines changed

‎ACKNOWLEDGEMENTS.md‎

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,42 @@ Readme has been inspired by the amazing Netdata community project.
88
[Netdata](https://github.com/netdata/netdata)
99

1010

11-
immudb uses the following open source projects.
11+
immudb uses the following amazing open source projects. Copyright by their respective copyright holders and vChain, Inc.
12+
13+
| Project | License |
14+
| ------------------------------------------------------------ | ------------------------------------------------------------ |
15+
| [badger](https://github.com/dgraph-io/badger) | [Apache License 2.0](https://github.com/dgraph-io/badger/blob/master/LICENSE) |
16+
| [cobra](https://github.com/spf13/cobra) | [Apache License 2.0](https://github.com/spf13/cobra/blob/master/LICENSE.txt) |
17+
| [go-homedir](https://github.com/mitchellh/go-homedir) | [MIT](https://github.com/mitchellh/go-homedir/blob/master/LICENSE) |
18+
| [viper](https://github.com/spf13/viper) | [MIT](https://github.com/spf13/viper/blob/master/LICENSE) |
19+
| [xid](https://github.com/rs/xid) | [MIT](https://github.com/rs/xid/blob/master/LICENSE) |
20+
| [Prometheus Go client library](https://github.com/prometheus/client_golang) | [Apache License 2.0](https://github.com/prometheus/client_golang/blob/master/LICENSE) |
21+
| [Go gRPC Middleware](https://github.com/grpc-ecosystem/go-grpc-middleware) | [Apache License 2.0](https://github.com/grpc-ecosystem/go-grpc-middleware/blob/master/LICENSE) |
22+
| [go-toml](https://github.com/pelletier/go-toml) | [MIT](https://github.com/pelletier/go-toml/blob/master/LICENSE) |
23+
| [File system notifications for Go](https://github.com/fsnotify/fsnotify) | [BSD 3-Clause "New" or "Revised" License](https://github.com/fsnotify/fsnotify/blob/master/LICENSE) |
24+
| [jWalterWeatherman](https://github.com/spf13/jwalterweatherman) | [MIT](https://github.com/spf13/jwalterweatherman/blob/master/LICENSE) |
25+
| [HCL](https://github.com/hashicorp/hcl) | [Mozilla Public License 2.0](https://github.com/hashicorp/hcl/blob/master/LICENSE) |
26+
| [mapstructure](https://github.com/mitchellh/mapstructure) | [MIT](https://github.com/mitchellh/mapstructure/blob/master/LICENSE) |
27+
| [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway) | [BSD 3-Clause "New" or "Revised" License](https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt) |
28+
| [cast](https://github.com/spf13/cast) | [MIT](https://github.com/spf13/cast/blob/master/LICENSE) |
29+
| [go-md2man](https://github.com/cpuguy83/go-md2man) | [MIT](https://github.com/cpuguy83/go-md2man/blob/master/LICENSE.md) |
30+
| [xxhash](https://github.com/cespare/xxhash) | [MIT](https://github.com/cespare/xxhash/blob/master/LICENSE.txt) |
31+
| [Data model artifacts for Prometheus](https://github.com/prometheus/client_model) | [Apache License 2.0](https://github.com/prometheus/client_model/blob/master/LICENSE) |
32+
| [pflag](https://github.com/spf13/pflag) | [BSD 3-Clause "New" or "Revised" License](https://github.com/spf13/pflag/blob/master/LICENSE) |
33+
| [Go support for Protocol Buffers](https://github.com/protocolbuffers/protobuf-go) | [License](https://github.com/protocolbuffers/protobuf-go/blob/master/LICENSE) |
34+
| [Ristretto](https://github.com/dgraph-io/ristretto) | [Apache License 2.0](https://github.com/dgraph-io/ristretto/blob/master/LICENSE) |
35+
| [AFERO](https://github.com/spf13/afero) | [Apache License 2.0](https://github.com/spf13/afero/blob/master/LICENSE.txt) |
36+
| [Blackfriday](https://github.com/russross/blackfriday) | [Simplified BSD License](https://github.com/russross/blackfriday/blob/master/LICENSE.txt) |
37+
| [Humane Units](https://github.com/dustin/go-humanize) | [License](https://github.com/dustin/go-humanize/blob/master/LICENSE) |
38+
| [sanitized anchor name](https://github.com/shurcooL/sanitized_anchor_name) | [MIT](https://github.com/shurcooL/sanitized_anchor_name/blob/master/LICENSE) |
39+
| [go-farm](https://github.com/dgryski/go-farm) | [MIT](https://github.com/dgryski/go-farm/blob/master/LICENSE) |
40+
| [PASETO](https://github.com/o1egl/paseto) | [MIT](https://github.com/o1egl/paseto/blob/master/LICENSE) |
41+
| [ChaCha20](https://github.com/aead/chacha20) | [MIT](https://github.com/aead/chacha20/blob/master/LICENSE) |
42+
| [Perks](https://github.com/beorn7/perks) | [MIT](https://github.com/beorn7/perks/blob/master/LICENSE) |
43+
| [Zstd Go Wrapper](https://github.com/DataDog/zstd) | [Simplified BSD License](https://github.com/DataDog/zstd/blob/1.x/LICENSE) |
44+
| [gotenv](https://github.com/subosito/gotenv) | [MIT](https://github.com/subosito/gotenv/blob/master/LICENSE) |
45+
| [poly1305](https://github.com/aead/poly1305) | [MIT](https://github.com/aead/poly1305/blob/master/LICENSE) |
46+
| [Go CORS handler](https://github.com/rs/cors) | [MIT](https://github.com/rs/cors/blob/master/LICENSE) |
47+
| [ntp](https://github.com/beevik/ntp) | [BSD 2-Clause "Simplified" License](https://github.com/beevik/ntp/blob/master/LICENSE) |
48+
1249

13-
- [badger](https://github.com/dgraph-io/badger)
14-
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

‎Dockerfile‎

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,42 @@
11
FROM golang:1.13-stretch as build
22
WORKDIR /src
33
COPY . .
4-
RUN GOOS=linux GOARCH=amd64 make immuclient-static immudb-static immugw-static
5-
FROM scratch
6-
COPY --from=build /src/immudb /bin/immudb
7-
COPY --from=build /src/immuclient /bin/immuclient
8-
COPY --from=build /src/immugw /bin/immugw
9-
10-
HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD [ "/bin/immuclient", "ping" ]
11-
ENTRYPOINT ["/bin/immudb"]
4+
RUN GOOS=linux GOARCH=amd64 make immuadmin-static immudb-static
5+
FROM ubuntu:18.04
6+
MAINTAINER vChain, Inc. <[email protected]>
7+
8+
COPY --from=build /src/immudb /usr/sbin/immudb
9+
COPY --from=build /src/immuadmin /usr/local/bin/immuadmin
10+
11+
ARG IMMU_UID="3322"
12+
ARG IMMU_GID="3322"
13+
14+
ENV IMMUDB_HOME="/usr/share/immudb" \
15+
IMMUDB_DIR="/var/lib/immudb" \
16+
IMMUDB_DBNAME="immudb" \
17+
IMMUDB_ADDRESS="127.0.0.1" \
18+
IMMUDB_PORT="3322" \
19+
IMMUDB_PIDFILE="/usr/share/immudb/immudb.pid" \
20+
IMMUDB_LOGFILE="/usr/share/immudb/immudb.log" \
21+
IMMUDB_MTLS="false" \
22+
IMMUDB_AUTH="false" \
23+
IMMUDB_DETACHED="false" \
24+
IMMUDB_PKEY="/usr/share/immudb/mtls/3_application/private/key.pem" \
25+
IMMUDB_CERTIFICATE="/usr/share/immudb/mtls/3_application/certs/server.pem" \
26+
IMMUDB_CLIENTCAS="/usr/share/immudb/mtls/2_intermediate/certs/ca-chain.pem"
27+
28+
RUN addgroup --system --gid $IMMU_GID immu && \
29+
adduser --system --uid $IMMU_UID --no-create-home --ingroup immu immu && \
30+
mkdir -p "$IMMUDB_HOME" && \
31+
mkdir -p "$IMMUDB_DIR" && \
32+
chown -R immu:immu "$IMMUDB_HOME" "$IMMUDB_DIR" && \
33+
chmod -R 777 "$IMMUDB_HOME" "$IMMUDB_DIR" && \
34+
chmod +x /usr/sbin/immudb /usr/local/bin/immuadmin
35+
36+
EXPOSE 3322
37+
EXPOSE 9497
38+
39+
HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD [ "/usr/local/bin/immuadmin", "status" ]
40+
USER immu
41+
ENTRYPOINT ["/usr/sbin/immudb"]
42+

‎Dockerfile.bench‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎Dockerfile.final‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎Dockerfile.immuadmin‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
FROM golang:1.13-stretch as build
2+
WORKDIR /src
3+
COPY . .
4+
RUN GOOS=linux GOARCH=amd64 make immuadmin-static
5+
FROM ubuntu:18.04
6+
MAINTAINER vChain, Inc. <[email protected]>
7+
8+
COPY --from=build /src/immuadmin /usr/local/bin/immuadmin
9+
10+
ARG IMMU_UID="3322"
11+
ARG IMMU_GID="3322"
12+
13+
ENV IMMUDB_ADDRESS="127.0.0.1" \
14+
IMMUDB_PORT="3322" \
15+
IMMUDB_MTLS="false"
16+
17+
RUN addgroup --system --gid $IMMU_GID immu && \
18+
adduser --system --uid $IMMU_UID --no-create-home --ingroup immu immu && \
19+
chmod +x /usr/local/bin/immuadmin
20+
21+
USER immu
22+
ENTRYPOINT ["/usr/local/bin/immuadmin"]
23+

‎Dockerfile.immugw‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
FROM golang:1.13-stretch as build
2+
WORKDIR /src
3+
COPY . .
4+
RUN GOOS=linux GOARCH=amd64 make immugw-static
5+
FROM ubuntu:18.04
6+
MAINTAINER vChain, Inc. <[email protected]>
7+
8+
COPY --from=build /src/immugw /usr/sbin/immugw
9+
10+
ARG IMMU_UID="3322"
11+
ARG IMMU_GID="3322"
12+
13+
ENV IMMUGW_HOME="/usr/share/immudb" \
14+
IMMUGW_ADDRESS="0.0.0.0" \
15+
IMMUGW_PORT="3323" \
16+
IMMUGW_IMMUDBADDRESS="127.0.0.1" \
17+
IMMUGW_IMMUDBPORT="3322" \
18+
IMMUGW_MTLS="false" \
19+
IMMUGW_DETACHED="false" \
20+
IMMUGW_PKEY="/usr/share/immudb/mtls/3_application/private/key.pem" \
21+
IMMUGW_CERTIFICATE="/usr/share/immudb/mtls/3_application/certs/server.pem" \
22+
IMMUGW_CLIENTCAS="/usr/share/immudb/mtls/2_intermediate/certs/ca-chain.pem"
23+
24+
RUN addgroup --system --gid $IMMU_GID immu && \
25+
adduser --system --uid $IMMU_UID --no-create-home --ingroup immu immu && \
26+
mkdir -p "$IMMUGW_HOME" && \
27+
chown -R immu:immu "$IMMUGW_HOME" && \
28+
chmod -R 777 "$IMMUGW_HOME"
29+
chmod +x /usr/sbin/immugw
30+
31+
EXPOSE 3323
32+
33+
HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD [ "/usr/sbin/immugw", "version" ]
34+
USER immu
35+
ENTRYPOINT ["/usr/sbin/immugw"]
36+

0 commit comments

Comments
 (0)