Skip to content

Commit 5aea5b0

Browse files
soc docs update for 1.4 (#1000)
1 parent e5e9877 commit 5aea5b0

11 files changed

+158
-0
lines changed

docs-source/spring/content/platform/soc/_index.md

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,36 @@ resources:
8484
- name: soc-alerts
8585
src: "soc-alerts.png"
8686
title: "Alerts"
87+
- name: soc-workload-details
88+
src: "soc-workload-details.png"
89+
title: "Workload Details"
90+
- name: soc-workload-details-overview
91+
src: "soc-workload-details-overview.png"
92+
title: "Workload Details: Overview"
93+
- name: soc-workload-details-overview-scale
94+
src: "soc-workload-details-overview-scale.png"
95+
title: "Workload Details: Scale workload"
96+
- name: soc-workload-details-hpa
97+
src: "soc-workload-details-hpa.png"
98+
title: "Workload Details: Horizontal Pod Autoscaler(HPA)"
99+
- name: soc-workload-details-hpa-create
100+
src: "soc-workload-details-hpa-create.png"
101+
title: "Workload Details: Create HPA"
102+
- name: soc-workload-details-route
103+
src: "soc-workload-details-route.png"
104+
title: "Workload Details: APISIX Routes"
105+
- name: soc-manage-config
106+
src: "soc-manage-config.png"
107+
title: "Manage Configuration"
108+
- name: soc-manage-config-create
109+
src: "soc-manage-config-create.png"
110+
title: "Create Configuration"
111+
- name: soc-manage-config-update
112+
src: "soc-manage-config-update.png"
113+
title: "Update Configuration"
114+
- name: soc-manage-config-delete
115+
src: "soc-manage-config-delete.png"
116+
title: "Delete Configuration"
87117
---
88118

89119
Oracle Backend for Microservices and AI includes "ServiceOps Center". The ServiceOps Center provides a web user interface to manage the Oracle Backend for Microservices and AI. This release includes the following capabilities:
@@ -115,12 +145,20 @@ Oracle Backend for Microservices and AI includes "ServiceOps Center". The Servic
115145
- [Upload workload binary](#upload-workload-binary)
116146
- [Progress screen](#progress-screen)
117147
- [Delete Workload(s)](#delete-workloads)
148+
- [Workload Details](#workload-details)
149+
- [Overview](#overview)
150+
- [Horizontal Pod Autoscaler](#horizontal-pod-autoscaler)
151+
- [APISIX Routes](#apisix-routes)
118152
- [Manage Identity](#manage-identity)
119153
- [Create User](#create-user)
120154
- [Change Password](#change-password)
121155
- [Change Roles](#change-roles)
122156
- [Change Email](#change-email)
123157
- [Delete User(s)](#delete-users)
158+
- [Manage Configuration](#manage-configuration)
159+
- [Create Configuration](#create-configuration)
160+
- [Update Configuration](#update-configuration)
161+
- [Delete Configuration(s)](#delete-configurations)
124162
- [Collect Diagnostic Data](#collect-diagnostic-data)
125163
- [Alerts](#alerts)
126164
- [Usage Reporting](#usage-reporting)
@@ -376,6 +414,86 @@ To delete one or more workload, select and click "DELETE".
376414

377415
<!-- spellchecker-enable -->
378416

417+
#### Workload Details
418+
419+
To access details about a Workload, click on the name of the workload.
420+
421+
<!-- spellchecker-disable -->
422+
423+
{{< img name="soc-workload-details" size="medium" lazy=false >}}
424+
425+
<!-- spellchecker-enable -->
426+
427+
##### Overview
428+
429+
The Overview section on the Workload details page contains basic details of the workload such as
430+
431+
- Name of the workload
432+
- Image
433+
- Ports exposed by the workload
434+
- Link to the Spring Boot Statistics Grafana dashboard for the workload
435+
- Spring profile
436+
- Status of Health Probe
437+
- CPU Resource request
438+
- Name of the Liquibase database
439+
- Workload creation/last update timestamps
440+
- Replicas available
441+
- Overall status of the workload.
442+
443+
The Overview section also provides buttons to control state of the workload. You can click START to start a workload which is currently unavailable. Click STOP to stop a running workload. DELETE can be used to permanently remove a workload from the cluster.
444+
445+
<!-- spellchecker-disable -->
446+
447+
{{< img name="soc-workload-details-overview" size="medium" lazy=false >}}
448+
449+
<!-- spellchecker-enable -->
450+
451+
To scale the workload to a desired number of replicas, click SCALE and enter the number of replicas.
452+
453+
<!-- spellchecker-disable -->
454+
455+
{{< img name="soc-workload-details-overview-scale" size="medium" lazy=false >}}
456+
457+
<!-- spellchecker-enable -->
458+
459+
##### Horizontal Pod Autoscaler
460+
461+
The Horizontal Pod Autoscaler section contains basic details of the [Horizontal Pod Autocaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) or HPA present for a workload such as
462+
463+
- Name
464+
- Reference to target deployment
465+
- Target metric value
466+
- Minimum number of pods
467+
- Maximum number of pods
468+
- Current replicas
469+
- Age of HPA
470+
471+
If a HPA exists, DELETE button can be used to delete the HPA.
472+
473+
<!-- spellchecker-disable -->
474+
475+
{{< img name="soc-workload-details-hpa" size="medium" lazy=false >}}
476+
477+
<!-- spellchecker-enable -->
478+
479+
If no HPA exists for the workload, you can create one by clicking the CREATE button and entering HPA details.
480+
481+
<!-- spellchecker-disable -->
482+
483+
{{< img name="soc-workload-details-hpa-create" size="medium" lazy=false >}}
484+
485+
<!-- spellchecker-enable -->
486+
487+
##### APISIX Routes
488+
489+
The APISIX Routes section Name, Path and Target port of [APISIX Route](https://apisix.apache.org/docs/apisix/terminology/route/) present for a workload.
490+
491+
<!-- spellchecker-disable -->
492+
493+
{{< img name="soc-workload-details-route" size="medium" lazy=false >}}
494+
495+
<!-- spellchecker-enable -->
496+
379497
### Manage Identity
380498

381499
The Manage Identity screen is accessible from the Security menu and allows you to view and edit information about the users and roles defined in the Authorization Server included in the platform.
@@ -436,6 +554,46 @@ You can select one or more users and click "DELETE" to delete selected user(s).
436554

437555
<!-- spellchecker-enable -->
438556

557+
### Manage Configuration
558+
559+
The Manage Configuration screen is accessible from the Config-Server menu and allows you to view and edit external configuration in [Spring Cloud Config server](../config).
560+
561+
<!-- spellchecker-disable -->
562+
563+
{{< img name="soc-manage-config" size="medium" lazy=false >}}
564+
565+
<!-- spellchecker-enable -->
566+
567+
#### Create Configuration
568+
569+
You can click "CREATE" to create a new configuration by specifying the application name, Spring profile, config label, key and its value.
570+
571+
<!-- spellchecker-disable -->
572+
573+
{{< img name="soc-manage-config-create" size="medium" lazy=false >}}
574+
575+
<!-- spellchecker-enable -->
576+
577+
#### Update Configuration
578+
579+
You can select a configuration and click "UPDATE" to change its value.
580+
581+
<!-- spellchecker-disable -->
582+
583+
{{< img name="soc-manage-config-update" size="medium" lazy=false >}}
584+
585+
<!-- spellchecker-enable -->
586+
587+
#### Delete Configuration(s)
588+
589+
You can select one or more configurations and click "DELETE" to delete selected configuration(s).
590+
591+
<!-- spellchecker-disable -->
592+
593+
{{< img name="soc-manage-config-delete" size="medium" lazy=false >}}
594+
595+
<!-- spellchecker-enable -->
596+
439597
### Collect Diagnostic Data
440598

441599
The Collect Diagnostic Data is accessible from the Settings Menu and allows you to collect and download diagnostic data about your installation and platform. Verify its contents for any sensitive information before submitting with any support request.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)