-
Notifications
You must be signed in to change notification settings - Fork 1
User Guide English
This guide is translate from French Guide Guide utilisateur - French Version
EBAD is made up of 3 parts:
- The use or "function": this is where you will be able to launch a batch, add a scheduled task, retrieve or drop files
- Management: In this section you can add environments (or server), configure batches, folders and manage authorizations on your applications
- Administration: It allows you to manage all users, standards, applications and news
The User role is required for these actions.
To be able to launch a batch or do any other action, you must be authorized to an application. To do this, simply go to the "Accreditations" menu and click on the "+ New request" button. A dialog box opens, start typing the first characters of the application to see it offered to you, click on it then select the types of rights you want:
- Management right
- Right of use Click on the "send" button. When this is done, an EBAD administrator or an application manager will be able to validate your request.
_To start a batch, you first need access to the desired application (see 1.1 'Request access to an application') _
To start a batch, go to the Function> Batchs menu. Select at the top right the desired application as well as the environment on which you want to launch the batch.
A list with all the configured batches (see 2.x 'batch management' to configure the batches) is displayed. You have the possibility of:
- Modify the date present in the date file (see 3.x 'standards') by clicking on the calendar at the top right
- launch a batch with the default parameters by clicking on the "Launch" button
- launch a batch with parameters by clicking on the button "Launch with parameters"
When you launch a batch, a notification appears to tell you if the batch has been launched and its possible return. You can consult all the batch launches in the Function> Traces menu (see 1.6 'Consult the traces')
_To start a chain, you first need access to the desired application (see 1.1 'Request access to an application') _
A chain is a series of batch launches. Let us take the example of a batch A, of a batch B and of a batch C. A chain could be the launching of the batch A then of the batch C then the batch B and finally again the batch A (see 2.x 'chain management').
To start a chain of batches, go to the Function> Chains menu. Select at the top right the desired application as well as the environment on which you want to launch the channel.
A list with all the configured strings (see 2.x 'batch management' to configure the batches) is displayed. You have the possibility :
- Modify the date present in the date file (see 3.x 'standards') by clicking on the calendar at the top right
- launch a batch with the default parameters by clicking on the "Launch" button
When you launch a channel, a notification appears to let you know if the channel is launched. You can consult all the launches of the batches that make up the chain in the Function> Traces menu (see 1.6 'Consult the traces')
_To schedule a task, you first need access to the desired application (see 1.1 'Request access to an application') _
Since version 2.4.0, EBAD allows adding scheduled tasks. A scheduled task is the launch of a standard batch with a periodicity defined using the CRON syntax (see [online cron syntax generator] (https://www.freeformatter.com/cron-expression-generator- quartz.html)).
To create a scheduled task, go to the Function> Schedulers menu. At the top right, select the desired application and the environment in which you want to create a scheduled task. Click on the '+ Add a scheduled task' button, a dialog box appears. Select the desired batch, any parameters as well as the cron expression. Once the task has been created, it will be executed automatically in the background on EBAD, no notification is sent by EBAD. You can view all the batch launches in the Function> Traces menu, the user still being 'ebad' (see 1.6 'Viewing traces')
To delete a scheduled task, go to the Function> Schedulers menu. A list with all the scheduled tasks already created is displayed, click on the corresponding "delete" button. correspondant to the scheduled task to be deleted. If the task is in progress, it will be interrupted immediately.
To send and / or retrieve a file, you first need access to the desired application (see 1.1 'Request access to an application') To send and / or retrieve a file, go to the Function> File menu. At the top right, select the desired application as well as the environment and finally the folder in which you want to send and / or retrieve a file.
The display of the contents of the folder may vary depending on the rights granted by the EBAD manager:
- read rights: A list of files is displayed with the size in bits and the creation date, you can download each file.
- write right: it is divided into three parts:
- the upper part, allows you to drag / drop files in order to send them to the remote server
- the left part, allows you to see the previously dragged / dropped files. They have not yet sent. You can rename them by clicking on the 'rename' button, delete them so as not to send them by clicking on the 'delete' button or send everything by clicking on the blue 'Send to server' button
- the right part, allows you to have the same information as with the read right.
If the exploration right is applied to the folder, you can browse the directories using the 'Browse' button.
To consult the traces, you first need access to the desired application (see 1.1 'Request access to an application') To view the traces of the batches launched, go to the Function> Traces menu. Select at the top right the desired application as well as the environment in which you wish to consult the tracks.
A list of traces is displayed, each element of this list is a batch launch containing the following information:
- Technical identifier (id)
- Functional name of the batch
- The processing date (the one contained in the date file)
- Any actual parameters (parameters)
- The identifier of the user being at the origin of the launch of the batch or 'ebad' if it is a scheduled task (user)
- The date of the batch launch (for the moment, this is the date and time of the end of the batch)
- The execution time expressed in milliseconds
- The return code of the batch, on UNIX the 0 corresponds to a success (return code)
In order to allow users to be able to launch a batch, retrieve a file or even schedule a task, you must configure various elements. First of all, make sure you are authorized to the desired application as managers and have the user role, these applications are configured by the EBAD administrators.
The basics are as follows:
- Application: The applications are the finest perimeters of confidentiality. They contain environments
- Environment: The environments correspond to servers which themselves contain batches, directories, strings and names
- Batchs: The batches represent a program that you want to launch
- Chains: Chains are sequences of scheduled batches
- Directories: Directories provide access to a directory on a server with read or read / write rights
- Names: Names are used to easily rename (according to a pattern) a file when it is sent to a server
- Identities: Identities are used to configure ssh users
In order to manage the accesses of an application, go to the Management> Access control menu. At the top right, select the desired application in which you want to manage access.
You have the complete list of users with access to this application, you can modify the rights of an authorized person. If a person no longer has any rights, they will then automatically delete people authorized to use the application. She will then have to request accreditation again (see 1.1 'Requesting access to an application').
In order to manage the SSH identities of an application, go to the Management> identities menu. Select at the top right the desired application in which you want to manage identities.
You have the list of identities available for this application (be careful, these are in addition to the global identities configured by an administrator which are available for all the applications), you can add, modify or delete an identity. Please note, all identity information is stored in clear in the database for the moment, this will change in the future.
To create an identity, all you have to do is, after selecting an application, click on the '+ New Identity' button. A dialog box appears :
- Name: free and compulsory field, in general the functional name (ex: user unix)
- Login: free and mandatory field, this is the login used to connect to the machine in SSH
- Password: free and optional field, this is the password associated with the login, this method is not recommended and this password is stored in clear in Ebad for the moment
- Private key: free and optional field, this is the private key associated with your login, the key is stored in clear in Ebad for the moment
- Private key path: free and optional field, this is the path to the private key associated with your login (recommended method)
- Private key password: free and optional field, this is the password associated with the private key, this password is stored in clear in Ebad for the moment
/! \ When a batch is started, Ebad first uses the Login with the password, then the private key by path and finally the "text" private key
In order to manage the accesses of an application, go to the Management> Environments menu. Select at the top right the desired application in which you want to manage the environments.
Depending on the configuration of EBAD performed by the administrator, there are two possible actions:
- '+ New Environment': when you click on this button, a dialog box opens with various information to provide:
- Name: free field, this name will appear in all 'environments' drop-down lists
- Server: IP address or name of the target machine
- Identity: the identity used to connect to the server (see 2.2 Identity management and 3.6 Identity administration)
- Home directory: absolute path to the directory containing your application (batches, logs, date file, etc.), do not end with a '/'
- Prefix: if the name of your shell (.ksh, .sh, .bat, etc.) is prefixed by a letter depending on the environment, then it must be specified here, otherwise leave empty
- Standard: select the desired standard, these are defined by the EBAD administrator
- '+ Import environments': when you click on this button, it imports the environments automatically depending on the plugin used (see 4.x 'The plugins')
In the list of environments, you can edit or delete an environment. If a batch is found without an environment, it will automatically be deleted, along with all associated traces, files and scheduled tasks.
🆕 If the Terminal function is activated (see 3.5 'Administrating EBAD parameters') an additional button is available on each environment line. This allows you to connect directly to the target server using the identity configured for this environment.
To manage the batches of an application, go to the Management> Batchs menu. Select at the top right the desired application in which you want to manage the batches.
To avoid creating the same batch for several environments, you can create a batch and assign it to several environments. To do so, click on the '+ New Batch' button, a dialog box opens:
- Name: free field, this is the functional name of your batch
- Shell: name of the program to start, without its possible prefix (ex: monbatch.sh)
- Parameters: these are the default parameters of the batch, you can leave empty (see 1.2 'Start a batch')
- Environments: this is where you must indicate on which environment this batch is available
A batch which ends up without an environment will be automatically deleted.
To manage the channels of an application, go to the Management> Channels menu. Select at the top right the application and the desired environment in which you want to manage the channels. Unlike batch management, the channels are not shared between several environments.
A chain is a series of batches on an environment (a batch can be there several times). To create a chain, all you have to do is, after selecting an environment, to click on the '+ New Chain' button. A dialog box appears :
- Name: free field, in general the functional name (ex: start of the day)
- Description: free field
- Batchs: select the different batches previously configured (see 2.4 'Batch management'). You can remove and reorder them by drag & drop.
To manage the directories of an application, go to the Management> Directories menu. Select at the top right the application and the desired environment in which you want to manage the directories.
To give the possibility to consult, browse and send files (see 1.5 'Send / Retrieve files'), you must add a new directory in EBAD by clicking on the '+ New Directory' button. A dialog box appears :
- Name: free field, generally the name of the directory or its function
- Path: the relative path of the directory according to the home directory of the environment (see 2.3 'Managing environments')
- Write right: gives the right to send files to this directory
- Right to explore: gives the right to browse the child directories
The names allow users to not know the technical names of the files. For example, if your batch expects a file in a directory with the name MYFICHIER.TXT then you (manager) create a name with this pattern which will have the name 'Working file'. The user will then only have to select the name "Working file" when sending the file (see 1.5 'Send / Retrieve files').
To manage the names of an application, go to the Management> Names menu. Select at the top right the desired application in which you want to manage the names.
To create a new naming, click on the '+ New naming' button, a dialog box is displayed:
- Name: free field, the functional name of the naming (ex: 'Working file')
- Pattern: free field, this is the final naming of the file. the character string '$ 1' will be replaced by the system date with the format DDMMYYYY_HHMM.
The administrator role is required to access these features.
In order to administer EBAD users, go to the Administration> Users menu.
You will find in this page the complete list of users, with the possibility:
- Activate / Deactivate a user by clicking on the corresponding button ('activated', 'unactivated'). If a user is deactivated then he will not be able to connect.
- Edit the roles of a user by clicking on the 'Roles' button of a user
- ROLE_ADMIN: gives access to the entire EBAD administration
- ROLE_USER: gives access to the functions of use and management of EBAD
- Edit the information of a user by clicking on the 'Edit' button of a user
To create a new user click on the '+ New User' button
You will find in this page the complete list of users, with the possibility:
- Activate / Deactivate a user by clicking on the corresponding button ('activated', 'unactivated'). If a user is deactivated then he will not be able to connect.
⚠️ Editing roles in OAUTH2 is not useful, this information comes from your IDP and will be deleted in a future version.⚠️ Editing a user in OAUTH2 is not useful, this information comes from your IDP and will be deleted in a future version.
Standards allow EBAD to function properly. Indeed, to know where to look for the batches, which command interpreter to use or to know where the date file is located for the Processing Date, it is necessary to create a standard.
Each environment is linked to a standard (see 2.3 'Managing environments').
To administer the EBAD standards, go to the Administration> Standards menu. To create a standard, all you have to do is click on the '+ New Standard' button, a dialog box is displayed:
- Name: free field, functional name of the standard (eg: "Standard standard")
- Command interpreter: allows you to use a different interpreter. It is a pattern, the character string '$ 1' corresponds to the command to be executed. You can put '$ 1' in this field if you want to use the default interpreter. You can specify for example '/ bin / ksh $ 1' to use ksh or even 'PowerShell.exe -Command ". $ 1"' to use PowerShell on Windows.
- Shell folder: path relative to the home directory of the environments containing the scripts to be executed (the 'shell' field of the batch). Here it is therefore the path of a directory.
- Date file path: path relative to the home directory of the environments. It is therefore the path of the date file which will contain the processing date.
To administer EBAD applications, go to the Administration> Applications menu.
Depending on the configuration of EBAD performed by the administrator, there are two possible actions:
- '+ New Application': when you click on this button, a dialog box opens with various information to provide:
- Code: free field, a code representing the application on 3 characters
- Label: free field, this name will appear in all the 'environments' drop-down lists
- Pattern date parameter: this is the date pattern (ex: [Date pattern generator] (https://www.timeanddate.com/date/pattern.html)) used to replace the '${DATE_TRAITEMENT}' through the date contained in the date file (see 3.2 'Administration of standards') in the format indicated
- Pattern date file: this is the date pattern (ex: [Date pattern generator] (https://www.timeanddate.com/date/pattern.html)) allowing to read and write the date in the date file (see 3.2 'Administration of standards') in the format indicated, via the function' Modification of processing date '
- '+ Import applications': when you click on this button, it imports the applications automatically depending on the plugin used (see 4.1 'The plugins')
To administer EBAD news, go to the Administration> News menu.
On the home page (when you are logged in), you can view news or other content. This is done through this administration.
To create a news, click on the '+ New news' button, a dialog box is displayed:
- Title: Free field
- Content: Free field, you can use the wysiwyg to format the content of your news.
- Rough draft? : If your news is in 'draft', it will not be visible on the home page
The news are displayed in descending order according to the creation date of the article.
In order to administer the EBAD parameters, go to the Administration> Parameters menu. The global parameters to EBAD are available on this screen, just click on 'disable' to deactivate them and 'enable' to activate them:
- APPLICATION_CREATE_ENABLED: allows the administrator, if enabled, to manually create applications in EBAD (see 3.3 'Application administration')
- APPLICATION_IMPORT_ENABLED: allows the administrator, if enabled, to import applications into EBAD via plugins (see 3.3 'Application administration' and 4.1 'Plugins')
- ENVIRONMENT_CREATE_ENABLED: allows an application manager, if enabled, to manually create environments in EBAD (see 2.3 'Managing environments')
- ENVIRONMENT_IMPORT_ENABLED: allows an application manager, if enabled, to import environments into EBAD via plugins (see 2.3 'Managing environments')
- TERMINAL_ENABLED : enable the terminal feature in environments management (see 2.3 'Managing environments')
You may need to refresh the browser after changing these settings.
In order to manage the SSH identities global to all the applications available in EBAD, go to the Administration> identities menu.
You have the list of identities available in EBAD (note, these are in addition to the identities of each application configured by a manager), you can add, modify or delete an identity. Please note, all identity information is stored in clear in the database for the moment, this will change in the future.
To create an identity, all you have to do is, after selecting an application, to click on the '+ New Identity' button. A dialog box appears :
- Name: free and compulsory field, in general the functional name (ex: user unix)
- Login: free and mandatory field, this is the login used to connect to the machine in SSH
- Password: free and optional field, this is the password associated with the login, this method is not recommended and this password is stored in clear in Ebad for the moment
- Private key: free and optional field, this is the private key associated with your login, the key is stored in clear in Ebad for the moment
- Private key path: free and optional field, this is the path to the private key associated with your login (recommended method)
- Private key password: free and optional field, this is the password associated with the private key, this password is stored in clear in Ebad for the moment
/! \ When a batch is started, Ebad first uses the Login with the password, then the private key by path and finally the "text" private key
EBAD supports plugins to import applications and environments from external systems. The community can develop new ones and start EBAD with these plugins.
Since version 2.8.0 Ebad allows users to easily control its APIs directly in a Rest call (with for example curl, wget, postman, insomnia and any other client).
To do this, all you have to do is generate a token:
- Click on your first and last name at the top right of the EBAD application
- Click on "Profile"
- Click on "New Token"
- Indicate a name to your token
- Your token is displayed, be careful, it is not possible to recover this token again afterwards. If this token is lost, just delete it and recreate a new one
Once your token is created you can make your calls with the header "ebad-api-key" (name of the default header, configurable in your application.yaml).
An account can have several tokens. A token has no lifespan, but if it is deleted, then it will not be possible to use it.
En phase avec la version 2.10.0