Skip to content

Latest commit

 

History

History
224 lines (153 loc) · 5.2 KB

HOWTO.md

File metadata and controls

224 lines (153 loc) · 5.2 KB

Pre-requisites

python 3.9+
node v15.x
yarn v1.22.x
docker-desktop 3.5+

About 10GB of free disk space.
Recommended 4 core, 8+ GB RAM for docker.

Tested on OSX 11.5.2 with

python v3.9.2
node v15.11.0
yarn v1.22.5
docker-desktop v3.5.2, v3.6.0

For older versions of python (v3.7, v3.8), you may need to use an older version of pyspark (v2.4.8).
The pyspark consumer module may also need equivalent changes.

Clone Repo

$ git clone https://github.com/paljsingh/community-discussion.git  

$ cd community-discussion

Setup

$ ./setup.sh

ATTENTION: The docker images may take about 4GB of download and 20+ minutes to setup.

This will pull the docker images for

  • zookeeper
  • kafka
  • mongo db
  • spark
  • elasticsearch
  • kibana

also,

  • install python dependencies for the backend services.
  • install node / vue.js dependencies for the frontend service.
  • set up data, config and log directories for the applications.
  • download additional jars for spark/kafka and spark/elasticsearch integration.

Run

$ ./start.sh

This will -

  • Create a docker network
  • Run zookeeper
  • Run Kafka
    • create kafka topics.
  • Run mongo db
    • create indexes for mongo collections.
  • Run spark (master and worker nodes)
  • Run elasticsearch service
  • Run kibana server
  • Run flask server for each of the backend services
  • Run flask/websocket application
  • Tail the logs for all the components
  • Run frontend vue.js server

One can also start a single component as:

./start.sh [kafka|mongo|spark|elasticsearch|kibana|backend|frontend]

Producers and Consumers

Kafka producers are embedded in the backend server apis, and will generate events upon receiving requests on http REST / websocket endpoints. No additional step is required for the kafka producers.

For Kafka consumers - Run the following commands in a separate terminal session(s) -

$ ./start.sh sparkspeed  

$ ./start.sh sparkbatch    # not yet implemented in PoC.

The above will create one process per kafka topic, consume the streamed event, process/transform and save them to elasticsearch.

UI

Visit http://localhost:8080

Login as admin by using the okta login link. To obtain admin token, Go to
Profile link -> Admin JWT Token [TBD]
or
Copy it from
Developer Tools -> Application -> Local Storage -> http://localhost:8080/ -> okta-token-storage -> accessToken -> accessToken

Admin users can copy the JWT tokens of other users by visiting the users tab, and clicking on the Copy Token button for one of the users.

Another incognito windows (or a new firefox/chrome profile) can be used to impersonate / login as a non-admin user, by pasting their JWT token on the login page.

Users can view other users, view/create communities, create usergroups or chat with other users.

Caveat:

  • All the incognito windows in Chrome (or firefox) share the user cookies/tokens, so it is not possible to open multiple incognito windows and impersonate multiple users.

However, one can

  • Create a new chrome/firefox profile and impersonate 2 new users (1 with incognito window, 1 with non-incognito window of the new profile)
  • Use a second browser.

Content Generation

In a new terminal session -

$ source venv/bin/activate  

$ export ADMIN_TOKEN='jwt-token-of-the-admin-user'  

$ python3 scripts/chaos.py

or

$ python3 scripts/chaos.py 1000

The script above creates a total of given number of resources
(100 if no arguments specified).

The resources are

  • users
  • communities
  • usergroups
  • text posts
  • image posts
  • video posts

The distribution of number of resources of each type are controlled by the configs defined in scripts/etc/chaos.yaml

For creating new users, admin jwt token is used. All the other resource creation requests use a random non-admin user's JWT token to simulate cases like:

  • users creating a community
  • users creating user groups and adding other users to it.
  • users posting text / image / video content to the communities.

Once the fake content is generated, you should be able to see it on the UI.

Login via another non-admin/dummy user by copy/pasting it's JWT token in login page, and create new communities / post content in a community, or initiate a chat with another user. [TBD]

Analytics Dashboard

Pre-saved index-patterns and dashboards are available under
data/kibana/ folder, that can be imported to the newly launched kibana service.

$ ./import-kibana.sh

Visit: http://localhost:5601

Under Home -> dashboard, it should list 2 dashboards, showing the statistics about the users, communities, usergroups, posts, images and videos.

Status

Status of the currently running services / components can be seen with:

$ ./status.sh

or

$ ./status.sh [mongo|kafka|spark|backend|frontend|elasticsearch|kibana]

Stop services

$ ./stop.sh

or

$ ./stop.sh [mongo|kafka|spark|backend|frontend|elasticsearch|kibana]

Cleanup

A cleanup script is provided to remove all application data, depdencies, docker images and logs, and restore the app to a pristine state.

$ ./cleanup.sh