3.6 System

This section describes the System Configuration tab, GitOps Log tab, and Import tab in the system application.

(1) System configuration tab

The System Configuration tab is for managing users and organizations, and it is used for settings that are reflected throughout the entire system for the functions provided by Ops I.

The System Configuration tab window consists of Operation buttons (①), Selection buttons (②), the navigation area (③) and the configuration area (④). Details are shown below.

(Figure) System Configuration tab window

(Figure) System window (Figure) System window


(Table) System Configuration tab window configuration

Components Description
① Operation buttons The appropriate button will be shown according to the window displayed.
The type of buttons displayed differs for each window.
② Selection buttons The buttons are used to switch between the windows displayed in the navigation area and the configuration area.
  • Left button: User management
  • Middle button: Organization management
  • Right button: Repository management
③ Navigation area Displays a hierarchy of the display content selected with ②.
④ Configuration area Displays the window for the selected content.


(2) GitOps log tab

In the GitOps Log tab, you can verify the status of YAML file registration based on the API “gitops-logs”.
The API “gitops-logs” is automatically executed when the GitOps Log tab is accessed, and the results are displayed, including whether operations on executed YAML files succeeded or failed, as well as file errors (syntax or dependencies) that caused failures. The validation results for YAML files that can be checked by executing the API “gitops-logs” are provided for all repositories, regardless of the group to which the user belongs.
The GitOps Log tab can be used by users who are assigned the Primitive role "gitops_logs_viewer".

Editing of the GitOps Log tab window is not supported. Details are shown below.

(Figure) GitOps Log tab window

(Figure) GitOps Log tab window (Figure) GitOps Log tab window


(Table) GitOps Log tab window configuration

Components Description
① Registration results Displays the GitOps log (results of executing the API "gitops-logs"). Selecting any cell in the row you want to check the results will display the details in areas ② and ③.
② Selected cell Displays the value of the cell selected in ①.
③ Detailed result Displays the values in the detail column (registration result details) of the row containing the cell selected in ①.

The display of the results can be changed at any time after accessing the GitOps Log tab. By displaying the log for the time period when the YAML file operation was executed, you can confirm the desired log.
The language of the error messages displayed in the Detailed result cannot be changed either in the language settings of Ops I or in the language settings of the browser.

(Table) GitOps log display change items

Item Description
page Specify page browse
pageSize Number of logs to display on one page

When these values are changed, the API is re-executed based on this information and the log is displayed.

For how to read the GitOps log, such as the operation success/failure, see “Checking registration status of YAML files”.

NotesNotes

The following "failed" results may appear in the GitOps log, but this is not a problem.

kind: system
name: conf
result: failed
reason: format_error
detail.message: "Validator for kind 'system', apiVersion '1.0' does not exists"



(3) Import tab

The Import tab enables you to import CSV files containing group information, role information, and customer information that was entered when, for example, Ops I was deployed, and create them in bulk.
You can verify the import status on the import job list window. If an error occurs, you can identify the row causing the error.
The [Group] window and the [Role] window allow you to view registered groups and roles, as well as export them. For details, see “Basic window structure”. In addition, registered customers can be viewed from “[Customers] > [Customer Administration]” in the ITSM application. For details, see “[Customers] > [Customer Administration]” in “JP1 Cloud Service/Operations Integration User’s Guide (ITSM Operation Manual)”.
The Import tab can be used by users who are assigned both the Primitive roles “user_admin” and “resource_importer”.

The import job list window consists of the Import button (①) and the import job list (②). The details are as follows.

(Table) Components of the import job list window

Component Description
① Import button Clicking this button displays the import dialog box.
For details, see "(Table) Components of the import dialog box".
② Import job list Details on import jobs are displayed in a list.
The following items are displayed:
  • Job ID: The ID of the import job is displayed.
  • Resource Type: Displays the type of the imported resource (group, role, customer, or custom-data).
    If the Primitive role "resource_importer" is not assigned, import jobs with a resource type of "custom-data" are not displayed.
  • File Name: The name of the imported CSV file is displayed.
  • Num Rows Imported: The number of successfully imported rows is displayed.
  • Error Rows: The number of rows that could not be imported is displayed.
    Clicking this downloads a CSV file containing information about the error result.
  • Total Rows: The total number of rows, including both successfully imported rows and error rows, is displayed.
  • Status: The progress of the import is displayed.
    The following statuses are displayed:
    • accepted: Waiting for processing.
      The import job has been accepted by the system and is waiting to be processed.
    • processing: In progress.
      The import job is currently being processed. Each row in the CSV file is processed in sequence.
    • succeeded: Completed successfully.
      All records have been successfully imported.
    • error: Error.
      The import job has completed, but errors occurred in some rows. You can view details of the rows where errors occurred.
  • Created By: The user who performed the import is displayed.
  • Created On: The time when the import started is displayed (YYYY-MM-DD hh:mm:ss ±hh:mm).
  • Finished On: The time when the import was completed is displayed (YYYY-MM-DD hh:mm:ss ±hh:mm).

Clicking the Import button displays the import dialog box. This dialog box enables you to upload a CSV file. You can start the import by selecting the resource type. The details are as follows.

(Table) Components of the import dialog box

Component Description
① Resource type Select the import target from "Group", "Role", and "Customer".
② Import file upload area Upload the CSV file to be imported.
When you click the "select" link in response to "Drop or select a file to add", the file operation dialog box is displayed. To upload a CSV file, select it from the file operation dialog box or drop it to the dotted box. You cannot upload multiple CSV files simultaneously. You can upload a file that meets the following conditions:
  • The file size must be 100 MB or less.
  • The character encoding must be UTF-8 (without BOM).
If you select a CSV file exceeding 100 MB, an error message will be displayed and the import will not be performed.
③ Start import Clicking this imports the CSV file uploaded in the import file upload area.
This is not activated when no file is uploaded in the import file upload area.
④ Cancel Clicking this closes the import dialog box without uploading any CSV file.

The CSV file format differs depending on the import target. The formats are explained in the tables shown below. Here, only the data items of groups, roles, and customers that are subject to import are listed.
The data items that are not subject to import (excluding the valid field for a customer) are not fields required for a group, role, or customer, so additional fields should be specified on an as-needed basis. The valid field for a customer is created in a valid state.
When entering data items on the first line of the CSV file, you must separate those data items by commas (,). On the second and subsequent lines, you must enter comma-separated values to be imported in the order the values are located on the first line.
When specifying multiple values for a data item, you must separate those values by semicolons (;).

<Example>

name,email,description,assignedRoles
dev,dev@example.com,DevelopmentTeam,role1;role2

(Table) CSV format for groups

Data item Type Required Description
name string Yes Group name
email string No E-mail address of the group
description string No Group detail
assignedRoles array No Roles associated with the group
Only roles existing in Ops I can be specified. The roles to be specified must be created or imported beforehand.

(Table) CSV format for roles

Data item Type Required Description
name string Yes Role name
description string No Role detail
associatedRoles array No Related roles
Only roles existing in Ops I can be specified. The roles to be specified must be created or imported beforehand.
CSV imports are performed in descending order of lines. Therefore, if you wish to import a role along with other roles specified in associatedRoles in the CSV file, the former role must be located on a line above the line specified by associatedRoles.

(Table) CSV format for customers

Data item Type Required Description
id string Yes Customer ID
name string Yes Customer username
street string No Street
zip string No Zip
city string No City
country string No Country
url string No URL
comments string No Comment

NotesNotes

  • If an error occurs during import, you must correct the problem causing the error and redo the import.
  • Do not edit any group, role, or customer while importing is in progress.



Section structure

3.6.1 User management
3.6.2 Identity provider
3.6.3 Organization management
3.6.4 Outpost management
3.6.5 Repository management