====== Organization onboarding ====== You need to register a new organization with all its underlying systems and components ===== Prerequisites ===== * You must have the creation permissions for Organizations, Groups, Systems, Connectors and Users * You must have the **View all** and **Edit all** permissions, or request those persmissions after having created the Organization * You need to have connection parameters of at least a subset of devices (host, credentials, etc...) ===== Before you start ===== ==== Short names ==== * Certain configuration elements necessitate the specification of a **short name** * This short name serves as a user-friendly, distinctive ID, connecting all underlying components and data. * Once created, **they can never be changed.** * Therefore, it is crucial to thoughtfully determine the approach for defining these short names at each level, and we highly recommend establishing a **naming convention** in advance. * Short names will be employed to form a resource locator that uniquely identifies a device, such as: ''/my_org/this_group/this_system'' ==== Collectors ==== * The cockpit cannot directly connect to the devices and systems * It uses one or several collectors as proxies to access those devices (see collectors) * You must have at least one collector capable of reaching your devices if you want to be able to monitor them * Only admin users can manage collectors, get back to them if you are not admin yourself ===== Configuration of monitored systems ===== * The monitoring section allows defining the relationship between the monitored components: * **Organizations**: Holds groups of systems of a given company * **Groups**: A group of systems * **Systems**: A logical SAP system * **Connectors**: The connection means to a system {{:products:cockpit:1.0:userguide:pasted:20240208-150428.png}} ==== Systems definition ==== Systems are organized within **Organizations** and **Groups**, this is where the configuration starts * Navigate to the ''Organizations'' menu and create new one. * The organization item will be used to identify a company owning the underlying devices * Pay attention to carefully set its shortname * Once created, use the **plus** button to create a group * Groups can be used to organize your devices into sets of arbitrary groups (By country, by role, etc...) * Systems within a group **must be reachable from the same collector**, keep that in mind when defining your groups * Once at least a group is created, navigate to the ''Groups'' menu to start creating your devices * You can also ask an admin to assign a collector to your groups * Click on the **plus** button to create a **System** * Choose the appropriate type of system * Set a meaningfull title, try avoiding using too long title for the sake of display * Carefully choose its shortname (System Id for SAP system is recommended) * Once you have created your systems, navigate to ''Systems'' menu and use the **Add connnector** button to start creating your connectors * For each system, you need to create at least one connector * Each connector will have specific settings and prerequisites, refere to the dedicated documentation. * Once a connector is created, you can test its connectivity by using the test button (Its group must be associated to a collector first) ==== Monitoring configuration ==== Once your connectors are defined, you can start to activate the monitoring. This is done in two steps: * Create and configure [[..:userguide:monitoring:profiles|Monitoring profiles]] * **Assign** profiles to connectors Configuration steps: * Navigate to ''Profiles'' menu: * **create** or **import** the necessary profiles for your use case * Navigate to ''Connectors'' menu: * Select a connector by clicking on its name, it will open the monitoring configuration menu on the right. * Select **assign** and choose one or several profiles * You can optionnaly customize the **monitors** associated to each collector * you can also **test** each monitor (Its group must be associated to a collector first) * To start monitoring the system associated to a connector, **Activate** the connector by selecting its checkbox and press **Activate selection** button. ==== Collector association ==== * As soon as a group is created, it can be associated to one or several collectors * This is a mandatory step if you want to be able to test connectors and monitors * This operation can only be done by an admin user ===== Usage ===== Once configuration step is complete for a system, you can start visualizing and interacting with it via menus from the ''Applications'' section.