How-to guides
Users can create the service by entering the required information for the Config Inspection service and selecting detailed options through the Samsung Cloud Platform Console.
Create Certificate
To create and use the Config Inspection service in the Samsung Cloud Platform Console, you need to generate an authentication key in advance.
Authentication key creation can be done from My menu > My Info. > Authentication Key Management > Create Authentication Key. For more details, refer to Manage Authentication Keys.
- The expiration period of the authentication key is up to 365 days.
- To generate an authentication key with no expiration date, you must create it permanently.
Create Config Inspection
You can create and use the Config Inspection service in the Samsung Cloud Platform Console.
To create a Config Inspection, follow these steps.
- Click the All Services > Security > Config Inspection menu. Navigate to the Service Home page of Config Inspection.
- On the Service Home page, click the Create Config Inspection button. You will be taken to the Create Config Inspection page.
- Config Inspection Creation On the page, input what is required to create a service, and select detailed options.
- Enter or select the required information in the Service Information Input area.
Category Required statusDetailed description Diagnosis Type - Automatic configuration via Console Cloud Required Select cloud for diagnosis - SCP: Samsung Cloud Platform
- AWS: Amazon Web Services
- Azure: Microsoft Azure
- Detailed input fields vary depending on the selected cloud type
Diagnostic Target > Diagnosis Name Required Name to distinguish the diagnostic target - Use the entered value as the resource name
- Enter within 25 characters using English letters, numbers, and special characters (
-,_)
Diagnostic target > Diagnostic account Required Console information to be diagnosed - Select the Account ID to diagnose from the list
- Selecting the same Account ID will result in duplicate requests and incur additional charges
- If AWS is selected, enter the Account ID (12 digits) for the diagnostic account
- If Azure is selected, enter the Subscription ID (36 characters, including letters, numbers, and special characters) for the diagnostic account
Diagnosis Schedule > Checklist Required Automatically set when Use is selected for diagnostic schedule Diagnostic Schedule > Diagnostic Cycle Required Select Diagnosis Interval - The diagnosis runs on the selected date according to the specified interval.
- If Monthly is selected, the diagnosis may not be performed on the selected date.
- Example) Selecting the 31st of each month – February has no such date, so the diagnosis is not performed.
Diagnostic Schedule > Start Time Required Select diagnostic start time - Set the hour and minute information for starting the diagnostic
authentication key Required Select the authentication key to use for Open API calls - Select button, click to choose the appropriate authentication key from the list in the Authentication Key Selection popup
- If no selectable authentication key is available, click Authentication Key Management to create a new authentication key
- For detailed information about authentication keys, refer to Manage Authentication Keys
Pricing plan Select Select a plan to use - Standard: Charged based on the number of diagnoses
- Monthly subscription: Charged a fixed amount each month regardless of the number of diagnoses (up to 30 diagnoses per month)
- The plan cannot be changed after the service is requested
Table. Config Inspection Service Information Input Items - In the Additional Information Input area, enter or select the required information.
Category Required statusDetailed description tag Select Add Tag - Up to 50 per resource can be added
- After clicking the Add Tag button, enter or select Key and Value values
Table. Config Inspection additional information input fields
- Enter or select the required information in the Service Information Input area.
- Summary Check the detailed information and estimated billing amount generated in the panel, and click the Create button.
- When creation is complete, check the created resources on the Config Inspection List page.
Check detailed information of Config Inspection
Config Inspection service allows you to view and edit the full resource list and detailed information. The Config Inspection Details page consists of Details, Tags, Activity History tabs.
To view detailed information of the Config Inspection service, follow these steps.
- Click the All Services > Security > Config Inspection menu. Navigate to the Service Home page of Config Inspection.
- On the Service Home page, click the Config Inspection menu. You will be taken to the Config Inspection list page.
- Config Inspection List page, click the resource to view detailed information. You will be taken to the Config Inspection Details page.
- Config Inspection Details page displays status information and additional feature information, and is composed of Details, Tags, Work History tabs.
Category Detailed description status Displays the status of Config Inspection - Ready: When there is no diagnostic request after the service is created (diagnostic request possible)
- In Progress: When a diagnostic request is being executed (diagnostic request/service termination not allowed)
- Error: When an error occurs in the diagnostic request (diagnostic request possible)
- Completed: When the diagnostic request completes successfully (diagnostic request possible)
Diagnostic request Button to perform console diagnostics Service termination Button to cancel the service Table. Config Inspection status information and additional features
- Config Inspection Details page displays status information and additional feature information, and is composed of Details, Tags, Work History tabs.
Detailed Information
Config Inspection List page lets you view detailed information of the selected resource and modify the information if necessary.
| Category | Detailed description |
|---|---|
| Service | Service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource name | Resource Name |
| Resource ID | Unique resource ID in the service |
| Constructor | User who created the service |
| Creation date and time | Service creation timestamp |
| Editor | User who edited the service information |
| Modification date | Date and time the service information was modified |
| Diagnosis Type | Diagnostic types offered by the service |
| Cloud | Diagnosis target types |
| diagnostic target | Console information for the diagnostic target
|
| Pricing plan | Selected plan type |
| Recent diagnosis date/time | Timestamp of the last executed diagnostic request |
| Recent diagnostic results | Result of the most recent diagnostic request
|
| authentication key | The authentication key of the user registered when creating the service
|
| Diagnostic Schedule | Display selected diagnostic schedule information
|
tag
Config Inspection List page lets you view the tag information of the selected resource and add, modify, or delete it.
| Category | Detailed description |
|---|---|
| Tag list | Tag list
|
Job History
On the Config Inspection List page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|---|
| Task History List | Resource Change History
|
Config Inspection Resource Management
If you need to view the status of a Config Inspection resource or request a diagnosis, you can perform the task on the Config Inspection List or Config Inspection Details page.
Modify authentication key
You can select the authentication key to use for diagnosis for each diagnostic target.
To modify the service’s authentication key, follow these steps.
- Click the All Services > Security > Config Inspection menu. Navigate to the Service Home page of Config Inspection.
- On the Service Home page, click the Config Inspection menu. You will be taken to the Config Inspection list page.
- On the Config Inspection List page, click the resource whose authentication key you want to edit. Then go to the Config Inspection Detail page.
- Check the authentication key and click the Edit icon. The Edit Authentication Key popup window opens.
- Edit Authentication Key Select the authentication key to use in the popup window and click the Confirm button.
Category Detailed description authentication key Authentication Key Detailed Information Creation date and time Authentication key creation date Expiration date and time Authentication key expiration date status Authentication key status - Active: Usable
- Expired: Usage period expired
Table. Authentication key edit popup items
- If the authentication key is deleted, it is displayed in the
-state. - The authentication key information (authentication key, status) of resources created by other users is displayed as
-.
Request Diagnosis
You can request a diagnosis from the Console based on the configured checklist.
To request a console diagnosis, follow these steps.
Click the All Services > Security > Config Inspection menu. Navigate to the Service Home page of Config Inspection.
On the Service Home page, click the Config Inspection menu. You will be taken to the Config Inspection list page.
On the Config Inspection List page, click the resource you want to request a diagnosis for. You will be taken to the Config Inspection Details page.
On the Config Inspection Details page, click the Diagnostic Request button. The Diagnostic Request popup opens.
In the Diagnosis Request popup, enter the information required for the diagnosis and click the Confirm button.
- Diagnostic Request The items in the popup window vary depending on the selected Console.
Category Detailed description Console access method Fix the authentication key method as the console access method. Checklist Set to Best Practice when selecting SCP authentication key If you select SCP, choose the pre-generated authentication key. Access Key If AWS is selected, enter the Access Key. Secret Key If AWS is selected, enter Secret Key Client ID Enter Client ID when Azure is selected Client Secret If Azure is selected, enter Client Secret Tenant ID If Azure is selected, enter Tenant ID Table. Diagnosis request popup items
- Diagnostic Request The items in the popup window vary depending on the selected Console.
Check the status value on the Config Inspection list page.
- When the diagnostic request is completed, the status value is displayed as Completed or Error.
- In the case of Completed, you can view the diagnostic request results in the diagnostic results menu. For more details, refer to Report Management.
Terminate Config Inspection
You can cancel the Config Inspection service you are not using. However, canceling Config Inspection will delete all stored diagnostic data.
- If you terminate the resource, all diagnostic data will be deleted, and you will not be able to view diagnostic results in the Report.
- If the status of the Config Inspection service is In Progress, the service cannot be terminated.
To disable Config Inspection, follow these steps.
- Click the All Services > Security > Config Inspection menu. Navigate to the Service Home page of Config Inspection.
- On the Service Home page, click the Config Inspection menu. You will be taken to the Config Inspection list page.
- On the Config Inspection List page, click the resource to be terminated. You will be taken to the Config Inspection Details page.
- Config Inspection Details on the page, click the Cancel Service button.
- After the termination is complete, check on the Config Inspection List page whether the resource has been terminated.