• Event Fabric

  • The main thing when we say "Event Fabric"

  • We usually abbreviate it as "EF"

  • Backend running on chicago "Event Fabric Backend"

  • Frontend runs in browsers "Event Fabric Frontend" or "Event Fabric Dashboards"

• Event Fabric Connect

  • A standalone tool to consume data and sent it to "Event Fabric"

  • We usually abbreviate it as "EFC"

  • Can run on more than one computer, now running on chicago (I think)

    • You can run it in your computer to play and try new things

• Event Fabric Admin

  • Admin UI to manage users, groups and permissions

• Roles

  • Users

  • Groups

    • a user can belong to 0 or more groups

    • a group can belong to 0 or more groups

    • permissions applied to a group apply to the users/groups that belong to it

• Resources

  • Streams (called "Channels" in the UI)

  • Buckets (called "Groups" in the UI)

    • a stream belongs to 1 bucket

    • two level hierarchy

• Permissions

  • like tags

  • one role (user/group) has 0 or more permissions to a resource (stream/bucket)

• Examples:

  • User bob has permsision get on stream public/apps

  • User patrick has permission get and put on bucket _user_patrick

    • this means he can read and write on all streams under _user_patrick

get

Read from a stream or any stream on a bucket

put

Write to a stream or any stream on a bucket

list

List streams in a bucket

grant

Grant permissions on a bucket

delete

Delete stream or bucket

adminusers

create/update/delete users

$sys/metrics

metrics from Event Fabric

public/apps

list of available apps

_user_<username>/*

all streams from <username>

admin

created if not exists, can use the admin panel

anonymous

user assigned to request done by unauthenticated users

auth.backend.module

if set to ldap ldap will be used

auth.backend.ldap.host

host to use for LDAP/AD auth

auth.backend.ldap.port

port to use for LDAP/AD auth

auth.backend.ldap.local_auth_suffix

suffix to add to username to authenticate against local auth (for example: @local) instead of LDAP/AD

• Extract release into destination folder:

  tar -xzf event-fabric.tgz
  cd event-fabric

• Edit configuration in db_config/efserver.conf

• Start it (see next section)

• Check logs in efserver/log/

• Try accessing the dashboard

  • http://<host>:<port>/ui/

Important:

Only operate Event Fabric with its default user

Never start as root, otherwise files will be created with wrong
permissions and when started with correct user it will fail
with permission errors

efserver/bin/efserver start

starts the server

efserver/bin/efserver stop

stops the server

efserver/bin/efserver ping

pings the server to see if it's running

efserver/bin/efserver attach

advanced: attaches an interactive console to the running server only use it if you know what you are doing ;)

db_config/efserver.conf

Server configuration, each entry is documented in the comments

db_config/advanced.config

advanced: don't edit unless told to do so by support

Place where custom data that must survive upgrades must be placed

custom_data
├── dashboard-apps
└── dashboard-images

Event Fabric Dashboard Apps (Plugins) that are not in the standard distribution

dashboard-apps/my-app will be available under ui/apps/extra/my-app

Images that you want available to use in Event Fabric Dashboards that are not in the standard distribution

dashboard-images/my-image.png will be available under ui/img/extra/my-image.png

• Extract release into destination folder:

  unzip event-fabric-connect.zip
  cd event-fabric-connect

• Edit configuration in config.toml

• Start it

  • run.sh (Unix/Mac OS X)

  • run.bat (Windows)

  • start-service.sh/stop-service.sh

    • start/stop it as a service in Unix/Mac OS X)

• Check logs in logs/

• Try accessing the admin app

  • http://<host>:<port>/

    • Configured in config.toml

config.toml

Event Fabric Connect Configuration file

lib/

Folder containing JDBC drivers and Avro entity jars

logs/

Log files

ef.mv.db

Connectors configuration Database

• Zip folders

  • db_data

  • db_config

  • custom-data

  • optional: efserver/log

• Copy it somewhere else

Important:

Backup procedure may increase disk activity and make reads/writes
slower, this may cause reads/writes on Event Fabric to fail due to
timeouts.

Try to do backups on times of low activity or with Event Fabric stopped.

• Stop Event Fabric

• Unzip folders

• Place them in the correct place

• Start Event Fabric

  • Follow start procedure in installation section

Like Restore procedure but we replace old efserver folder with new one

• Stop Event Fabric

• Move current efserver folder to another location

• Move new efserver folder where current efserver folder was

• Start Event Fabric

  • Follow start procedure in installation section

If errors appear in the logs or can't start or access the dashboards, do the oposite as in the Upgrade procedure

• Stop Event Fabric if started

• Move current efserver folder to another location

• Move last working efserver folder where current efserver folder was

• Start Event Fabric

  • Follow start procedure in installation section

• With Event Fabric Connect stopped

• Zip/copy

  • efc.mv.db

  • lib/

• With Event Fabric Connect stopped

• Unzip files and place them in the correct location

• Start Event Fabric Connect

• With Event Fabric Connect stopped

• Copy files from the current version to the new

  • efc.mv.db

  • lib/

• Start Event Fabric Connect