Setting up Jibe involves installing a Jibe container and configuring one or more event sources from which Jibe will read and process events. This document covers general setup. Event source pages will provide specific requirements and options for each source.
For general information see Jibe Documentation.
Jibe runs as a Docker container within a Access Anywhere node. Follow the instructions at Jibe Installation to install and start the container.
Jibe needs an Access Anywhere account with an Administrator role in order to synchronize files and objects.
If you are using CloudTrail logs this should also be the account used for running provider resyncs as Jibe can use additional metadata from sync tasks to determine sync baselines.
Jibe uses two configuration files located in /root/jibe/config
, one for runtime settings and one to configure logging.
Most options in these files can be changed at run-time. Allow up to a minute for Jibe to pick up changes.
Change the endpoint and credentials in jibe-config.json
to those of your
Access Anywhere Server.
{ "endpoint":"https://files.example.com", "login":"adminuser@example.com", "password":"*****", "sources" : [ { "flavor" : "SQS", "name" : "Amazon S3 Files" } ] }
If the account has 2FA enabled you can use an Authentication token instead of login and password.
"auth_token" : "123871230891203981123"
For more info see: Permanent API Tokens.
By default Jibe will create information and error logs under /root/jibe/logs
.
You can enable debug logs and send errors to Slack by changing the log options.
For information see Jibe Logging.
Sources define where events are coming from, either streaming sources or files.
Following the guides for each of the sources you will be creating:
These settings are optional and are generally only used by support.
Local directory for reports. Default is 'None'.
{ "data_dir" : "~/data/jibe" }
If not set reports are created in /tmp.
### Upload Folder
Access Anywhere folder to upload reports to. Set from the configuration file:
"upload_folder" : "/S3 Cloud/sme-demo-trails/reports"
Report name and optional directory below upload_folder. Allows reports to be collated for easier management. Name can also be changed. Datetime format variable 'now' is available.
report_filename' e.g. "{now:%Y-%d}/ProviderReport-{now:%Y-%m-%d}.htm"
How many worker threads for listing folders and reading files. Default is 15. Set from the configuration file.
"worker_threads" : 15
Each worker starts 1 or more threads to process sync events. Default is 5. Set from the configuration file.
"worker_sync_threads" : 5
Sets Max size of HTTP Pool (Requests HTTP Library). Recommend setting to at least worker_threads
up
to worker_threads
* worker_sync_threads
.
"http_pool_maxsize" : 30
Refresh interval for providers and their buckets in seconds. Allows providers and buckets to be added without restarting. Default is 3600 seconds (5 minutes).
"provider_refresh_seconds" : 3600
If the apiendpoint is different to the external endpoint it can be set in the config file. It supports multiple endpoints which aids in load balancing.
"apiendpoints" : [ "https://files.example.com" ]
"user_agent" : "Jibe/1.9"
The target folder adds a prefix to a source event before it's applied. Useful when mapping SMB notifications from a DFS target endpoint that are being applied to a DFS source.
"target_folder" : "Projects/CA/"
The file id of AWSLogs is cached in the Description field of the bucket. To change the location
change the value of AWSLogs
. Use the ID of the actual AWSLogs
folder as seen on the Info
panel for the folder.
Jibe:Syncing AWSLogs:320805592 AWSRegion:us-east-1 LastUpdated:2020-03-17 23:30:19Z
These settings are primarily for troubleshooting.
Shows recently completed tasks in the Provider Report.
"completed_queue_maxlen" : 50
Force start date for AWSLogs Sync.
"start_date"
Force end date for AWSLogs Sync.
"end_date"
Don't update database or data directory. Don't call provider sync, update complete markers and files. Read operations such as listing folder contents and downloading CloudTrail files are performed.
--dry-run
Default is False:
"dry_run" : true
Retries SyncOnProvider requests for new objects when a Not Found error is returned.
Configuration defaults:
"sync_not_found_retry" : 2 "sync_not_found_retry_seconds" : 5.0
Changes behaviour of GetFolderContents API calls.
By default folders that are being monitored will be refreshed at regular intervals by forcing a cloud refresh. This can be disabled:
"folder_cloud_refresh" : "n"
Configuration defaults:
"folder_cloud_refresh" : "y" "folder_page_size" : 100