Petals Cockpit 0.22.0-SNAPSHOT

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (32)

View Page History



h3. Application connector

By clicking on an user an edition form will unfold.

*In normal mode* (not LDAP), you can modify users to change their *name* and / or *password* (username cannot be changed) or *delete* them. Type new values in the corresponding field to change them. Leaving password empty will not change his their password. Then click "SAVE" ; "SAVE".



*In LDAP mode*, you can only *delete* users.

h2. The workspace perspective

The _workspace perspective_ is the perspective that opens by default when launching *Petals Cockpit*. 
The _workspace perspective_ is the perspective that opens by default when launching *Petals Cockpit*. 

The *workspace* is the entity that preserve the project and their contents. We contents. We can represent this as a directory. 
It aims to manage the different elements that make up the workspace: in particular the import of one or more *[bus ESB|https://doc.petalslink.com/pages/viewpage.action?pageId=1803735]* and the configuration of the elements in relation related to it as it as well as consultation of existing services.

By default, this perspective contains the following windows :
* The _Workspaces_ view _Workspaces_ view displays the workspaces accessible by the authenticated user and allows to add new ones by clicking on the button seems like (view list button) in the top left corner near the workspace name ;
* The _Workspace_ view _Workspace_ view that allows you to obtain information about it a workspace (description and list of users) is accessible by clicking on the button with its name in the top left corner or in the selection window at workspace ;
* The _Bus Import_ view displays a specific import form with controls on the imput fields. To access it, just click on the button with an add icon in the area to the left where is the content of *Petals* ;
* The _Petals_ view which allows to obtain a tree with all the elements attached to the bus. These elements are also called *resources*. Each of these resources has a detailed view, some also have a view of operations ;
* The _Bus Import_ view displays a specific import form with controls on the input fields. To access it, just click the button \(+) in the side panel next to the search bar;
* The _Petals_ view which allows to obtain a tree with all the elements attached to the bus. These elements are also called *resources*. Each of these resources has a detailed view (overview), some also have an operations view;
* The _Services_ view provides a detailed view of the service names and their dependencies.

h3. Creating the first workspace

Once logged in, you must set a name to your workspace. Then click on the add button to save it in a normally empty list on first use.
You can then see the name of the created workspace and your authorized access to access it.
Once logged in, you must set a name to your workspace. Then click on the button (new folder button) to add it.
You can then set the workspace description and manage the authorized users.


h3. Adding a new workspace

You can create as many workspaces as you want, but by default they will all be empty.
It will be necessary to select the one on which you wish to work on by simply clicking on it.

<img workspaces list>
By clicking on the input field from the users area, a list of users name will unfold. You can then:

* Add a user on this workspace by select a user name and clicking on "ADD" ;
* Delete him by clicking on the delete icon.
* Add a user on this workspace by selecting a user and clicking "ADD";
* Delete them by clicking delete button.

h3. Removing workspace

It is only possible to delete a workspace when in its view. Just click on the delete button at the top right of the page and confirm the deletion by clicking on "DELETE".

Be sure you want to do this because everything in this workspace will no longer exist for you but also users who also have access. for other users.

You will then be redirected to the list of available workspaces.
h3. Navigating between workspaces

It is possible to browse the list of available workspaces for the user (ie, having access to it) and navigate between the workspaces.&nbsp;You have to open the window of workspaces list, and click to the workspace of your choice to load this one.
It is possible to browse the list of available workspaces for the user (ie, having access to it) and navigate between the workspaces. You have to open the workspaces list view, and click the workspace of your choice to load it.

h1. Working with buses

Buses are a representation of a [Petals topology|https://doc.petalslink.com/display/petalsesb510/Topology+Configuration],&nbsp;composed topology|https://doc.petalslink.com/display/petalsesb510/Topology+Configuration], composed of registries, domains and containers. For now, only containers are represented in Petals Cockpit.

In Cockpit, _importing a bus_ means connecting to one of its containers (providing containers credentials and topology passphrase) in order to get topology informations from it. Then it tries to establish connection to all containers declared in the topology, gathering their informations in cockpit DB. Once _imported,_&nbsp;the bus and its containers are displayed in the Petals tab tree view.
h3. Importing a bus

In the Petals tab view, click on the add \(+) icon located in the top right corner of the tab panel, right next to the search bar. The _Workspace Bus Import_&nbsp;view Import_ view will open:

<img workspace bus import>

There you can fill all mandatory informations to connect to a Topology:
* *IP*&nbsp;(or *IP* (or *hostname)* and *port:* *port*: of a container to connect to it.
* *Username* and *password:*&nbsp;credentials *password*: credentials to connect to the container.
* *Topology passphrase:*&nbsp;to passphrase*: to allow accessing topology data.

At all time, fields can be cleared by clicking the *CLEAR* button.
Once all fields are filled, the *IMPORT*&nbsp;button will activate, click on it to start importing the Bus. This will create an&nbsp;_IMPORT IN PROGRESS_&nbsp;item.
Once all fields are filled, the *IMPORT* button will activate, click on it to start importing the Bus. This will create an _IMPORT IN PROGRESS_ item.

h3. Managing import in progress

As topology can be quite complex and distributed among several distant locations, importing a whole topology can take some time. Thus, while this action is performed on the server of cockpit, _IMPORT IN PROGRESS_&nbsp;view PROGRESS_ view (accessed by clicking on an item) will allow you to keep track and take actions. Once imported, the bus in progress should automatically disappear from the _IMPORTS IN PROGRESS_&nbsp;and PROGRESS_ and the imported bus show in the _BUSES_&nbsp;section.

Should a bus import fail, it will remain as failed bus in progress until deleted. You can click on it to see the error that prevented the import.

Both imports in progress and failed imports can be discarded using the *CANCEL* (or *DISCARD*) button. You can also click on *DISCARD AND RETRY*&nbsp;to RETRY* to discard the import and reopen the import form (keeping ip, port and username fields pre-filled). Password and Passphrase are not kept and must always be provided again.

h3. Deleting a bus

To delete a bus, click on the Bus item, then click on the delete icon (red icon with a garbage bin). A popup will ask you again if you wan to delete the bus, or cancel the action. Note: Buses are only deleted from the worskpace, they are not shown anymore in cockpit but the bus itself is not impacted. If the bus was also imported in another workspace before being deleted, it will remain imported in the other workspace.

h2. Visiting bus overview

By clicking on a bus item, you can go to its overview page. It will show the bus description and its containers. You can click on a container to go to the associated container overview.