Skip to content

Commit

Permalink
docker image versions, readme, changelog updated (#568)
Browse files Browse the repository at this point in the history
* #539 dependency updates

* #567 updated for 3.0.0

* #567 updated for 3.0.0
  • Loading branch information
arawinters authored Oct 17, 2024
1 parent b7b668b commit 7a4a6f2
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 21 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
[markdownlint](https://dlaa.me/markdownlint/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [3.0.0] - 2024-10-17

### Changed in 3.0.0

- Dependency updates.
- Searches can now survive a page reload
- Route Resolvers changed from Class to Fn

### Added in 3.0.0
- New Landing page
- Donut widget displaying how many records have been loader for each datasource.
- License widget displays how much of your current license is being used and it's expiration date.
- Cross Source Comparison widget. Allows selection of a data source or two and selection of the type of matches or relations for sample browsing.
- Sample browsing Data Table widget. Is populated from the user's selection from the Cross Source Comparison widget and allows the user to browse through a sample-set that matches the parameters selected.

## [2.9.4] - 2024-03-16

### Changed in 2.9.4
Expand Down
10 changes: 5 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
ARG BUILD_IMAGE=node:16-bullseye-slim@sha256:503446c15c6236291222f8192513c2eb56a02a8949cbadf4fe78cce19815c734
ARG PROD_IMAGE=node:16-alpine3.18@sha256:a1f9d027912b58a7c75be7716c97cfbc6d3099f3a97ed84aa490be9dee20e787
ARG TEST_IMAGE=node:16-bullseye-slim@sha256:503446c15c6236291222f8192513c2eb56a02a8949cbadf4fe78cce19815c734
ARG BUILD_IMAGE=node:20-bookworm-slim@sha256:ec35a66c9a0a275b027debde05247c081f8b2f0c43d7399d3a6ad5660cee2f6a
ARG PROD_IMAGE=node:20-alpine3.20@sha256:c13b26e7e602ef2f1074aef304ce6e9b7dd284c419b35d89fcf3cc8e44a8def9
ARG TEST_IMAGE=node:20-bookworm-slim@sha256:ec35a66c9a0a275b027debde05247c081f8b2f0c43d7399d3a6ad5660cee2f6a

FROM ${BUILD_IMAGE}
ENV REFRESHED_AT=2023-09-29
ENV REFRESHED_AT=2024-10-17

LABEL Name="senzing/entity-search-web-app" \
Maintainer="[email protected]" \
Version="2.9.2"
Version="3.0.0"

HEALTHCHECK CMD ["/app/healthcheck.sh"]

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ GIT_VERSION := $(shell git describe --always --tags --long --dirty | sed -e 's/\

# Docker variables

BASE_IMAGE ?= node:14-buster-slim
BASE_IMAGE ?= node:20.18-bookworm-slim
DOCKER_IMAGE_TAG ?= $(GIT_REPOSITORY_NAME):$(GIT_VERSION)
DOCKER_IMAGE_NAME := senzing/entity-search-web-app

Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Heck, it may not even be appropriate for your application of Senzing!

## Overview

This is an implementation of an entity search app which uses the senzing rest api server microservice to access functions of the Senzing API through a web interface.
This is an implementation of an entity search app which uses the senzing rest poc server microservice to access functions of the Senzing API through a web interface.

### Related artifacts

Expand Down Expand Up @@ -87,11 +87,11 @@ The following software programs need to be installed:
sudo docker pull senzing/entity-search-web-app
```

1. Pull the latest of the api server from [DockerHub](https://hub.docker.com/r/senzing/senzing-api-server).
1. Pull the latest of the poc server from [DockerHub](https://hub.docker.com/r/senzing/senzing-poc-server).
Example:

```console
sudo docker pull senzing/senzing-api-server
sudo docker pull senzing/senzing-poc-server
```

### Clone repository
Expand Down Expand Up @@ -187,13 +187,13 @@ The following docker containers communicate over a docker network.

### Run

1. Attach senzing-api-server.
1. Attach senzing-poc-server.
Example:

```console
sudo docker run \
--interactive \
--name=senzing-api-server \
--name=senzing-poc-server \
--publish 8080:8080 \
--rm \
--tty \
Expand All @@ -202,7 +202,7 @@ The following docker containers communicate over a docker network.
--volume ${SENZING_G2_DIR}:/opt/senzing/g2 \
--volume ${SENZING_VAR_DIR}:/var/opt/senzing \
${SENZING_NETWORK_PARAMETER} \
senzing/senzing-api-server \
senzing/senzing-poc-server \
-concurrency 10 \
-httpPort 8080 \
-bindAddr all \
Expand All @@ -214,7 +214,7 @@ The following docker containers communicate over a docker network.

```console
sudo docker run \
--env SENZING_API_SERVER_URL=http://senzing-api-server:8080 \
--env SENZING_API_SERVER_URL=http://senzing-poc-server:8080 \
--env SENZING_WEB_SERVER_PORT=8081 \
--interactive \
--name=senzing-webapp \
Expand Down Expand Up @@ -264,7 +264,7 @@ If you open that example up you will see two lines at the bottom of the file:

Those lines tell docker to pass two secrets to the services defined in the docker compose file.
These two lines should point to the location of the *server.key* and *server.cert* file you wish to use.
The configuration of the *senzing-api-server* service may differ from how you have set up your configuration to run.
The configuration of the *senzing-poc-server* service may differ from how you have set up your configuration to run.
You should copy over the configuration options defined in your *already working* docker-compose.yml file to the docker-stack.yml file.
The other important lines(under the *senzing-webapp* service definition) are:

Expand All @@ -287,7 +287,7 @@ check that the services started up successfully by typing `docker stack ps senzi

```bash
ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS
7mxc4jru51pl senzing-webapp_senzing-api-server.1 senzing/senzing-api-server:latest americium Running Running about an hour ago
7mxc4jru51pl senzing-webapp_senzing-poc-server.1 senzing/senzing-poc-server:latest americium Running Running about an hour ago
rnguy9d2incb senzing-webapp_senzing-webapp.1 senzing/entity-search-web-app:ssl americium Running Running about an hour ago
```

Expand Down Expand Up @@ -342,7 +342,7 @@ You can shut down the swarm node with `docker stack rm senzing-webapp`

### Admin Area

There is an *admin* area that can be used to create new datasources, and import data in to those datasources. In order to access this functionality your api server version must be >= 1.7.11 and it must be started with the `-enableAdmin` flag set to true.
There is an *admin* area that can be used to create new datasources, and import data in to those datasources. In order to access this functionality your poc server version must be >= 1.7.11 and it must be started with the `-enableAdmin` flag set to true.

The admin area can then be accessed by browsing to `/admin` on the same domain/hostname that you are running the webapp. You will be prompted to input an `Api Token`, this is the default security mechanism used to keep the riff-raff from doing unwanted things to your data. The token is randomly generated on server startup and output to stout in the same terminal used to start the container. Copy and past this token in to the login box when prompted.

Expand Down Expand Up @@ -396,13 +396,13 @@ The short version is find a machine with network access, then:

### Building from Source

1. Build Senzing api server. tag it as *senzing/senzing-api-server*.
Following the instructions at ["Senzing API server"](https://github.com/senzing-garage/senzing-api-server).
1. Build Senzing POC server. tag it as *senzing/senzing-poc-server*.
Following the instructions at ["Senzing POC server"](https://github.com/senzing-garage/senzing-poc-server).
Example:

```console
cd ../senzing-api-server
sudo docker build --tag senzing/senzing-api-server .
cd ../senzing-poc-server
sudo docker build --tag senzing/senzing-poc-server .
```

2. Build the web app.
Expand Down Expand Up @@ -511,7 +511,7 @@ There are several ways to run unit tests.

```console
sudo docker run \
--env SENZING_API_SERVER_URL=http://senzing-api-server:8080 \
--env SENZING_API_SERVER_URL=http://senzing-poc-server:8080 \
--env SENZING_WEB_SERVER_PORT=8081 \
--interactive \
--name=senzing-webapp-e2e \
Expand Down

0 comments on commit 7a4a6f2

Please sign in to comment.