Skip to content

Commit

Permalink
soc naming changes (#962)
Browse files Browse the repository at this point in the history
  • Loading branch information
lake-of-dreams authored Sep 30, 2024
1 parent 335170e commit 5cac3a1
Show file tree
Hide file tree
Showing 31 changed files with 39 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs-source/spring/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
- [Spring Boot Admin dashboard](platform/spring-admin/)
- [Spring Cloud Config server](platform/config/)
- [Spring Cloud Eureka service registry](platform/eureka/)
- [Spring Operations Center](platform/soc/)
- [ServiceOps Center](platform/soc/)
- Strimzi Kafka Operator

Developers also have access to development or build time services and libraries including:
Expand Down
46 changes: 28 additions & 18 deletions docs-source/spring/content/platform/soc/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Spring Operations Center"
description: "Using Spring Operations Center to manage applications in Oracle Backend for Microservices and AI"
title: "ServiceOps Center"
description: "Using ServiceOps Center to manage applications in Oracle Backend for Microservices and AI"
keywords: "soc operations admin springboot spring development microservices development oracle backend"
resources:
- name: soc-login-page
Expand Down Expand Up @@ -86,20 +86,18 @@ resources:
title: "Alerts"
---

Oracle Backend for Microservices and AI includes "Spring Operations Center". More capabilities will be added to this feature in future releases.

The Spring Operations Center provides a web user interface to manage the Oracle Backend for Microservices and AI. This release includes the following capabilities:
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:

- View details about the configuration and health of the environment
- Manage and deploy workloads (Spring Boot applications) deployed in the environment
- Manage and deploy workloads/microservices deployed in the environment
- Easy one-click access to Grafana dashboards for applications
- Manage users and roles defined in the Spring Authorization Server included in the environment
- Manage users and roles defined in the Authorization Server included in the environment
- Easy one-click access to Grafana dashboards for the Kubernetes cluster, the applications and the Oracle Database
- Collect diagnostic data for support

**Note:** More capabilities will be added to this feature in future releases.

- [Accessing Spring Operations Center](#accessing-spring-operations-center)
- [Accessing ServiceOps Center](#accessing-serviceops-center)
- [Login Screen](#login-screen)
- [Forgot Password](#forgot-password)
- [Reset Password](#reset-password)
Expand All @@ -121,21 +119,23 @@ The Spring Operations Center provides a web user interface to manage the Oracle
- [Create User](#create-user)
- [Change Password](#change-password)
- [Change Roles](#change-roles)
- [Change Email](#change-email)
- [Delete User(s)](#delete-users)
- [Collect Diagnostic Data](#collect-diagnostic-data)
- [Alerts](#alerts)
- [Usage Reporting](#usage-reporting)

### SMTP Settings

The Spring Operations Center can send emails for following operations:
The ServiceOps Center can send emails for following operations:

- [Forgot Password](#forgot-password)
- [Reset Password](#reset-password)
- [Forgot Username](#forgot-username)
- [Create User](#create-user)
- [Change Password](#change-password)
- [Change Roles](#change-roles)
- [Change Email](#change-email)

It is required to configure a SMTP secret as follows for the email functionality to work.

Expand All @@ -149,9 +149,9 @@ It is required to configure a SMTP secret as follows for the email functionality
--from-literal=SMTP_FROM=<from-email-address>
```

## Accessing Spring Operations Center
## Accessing ServiceOps Center

To access the Spring Operations Center, obtain the public IP address for your environment using this command:
To access the ServiceOps Center, obtain the public IP address for your environment using this command:

```bash
kubectl -n ingress-nginx get service ingress-nginx-controller
Expand Down Expand Up @@ -222,7 +222,7 @@ After logging in, you will see the SOC Dashboard.

## The Dashboard

The Spring Operations Center Dashboard provides information about the overall state of the environment including:
The ServiceOps Center Dashboard provides information about the overall state of the environment including:

- The version and platform the environment is running on
- The configuration and sizing of the Kubernetes cluster
Expand All @@ -239,15 +239,15 @@ The Spring Operations Center Dashboard provides information about the overall st

### Manage Namespaces

The Manage Namespaces screen is accessible from the _Workloads_ menu, and allows you to view and manage the namespaces that are configured for Spring Boot application deployments. Note that this does not show you all namespaces in the Kubernetes cluster, just those that have be specifically configured for Spring Boot workloads, meaning they have the necessary secrets for pulling images, accessing the database, and so on.
The Manage Namespaces screen is accessible from the _Workloads_ menu, and allows you to view and manage the namespaces that are configured for microservice deployments. Note that this does not show you all namespaces in the Kubernetes cluster, just those that have be specifically configured for workloads, meaning they have the necessary secrets for pulling images, accessing the database, and so on.

<!-- spellchecker-disable -->

{{< img name="soc-manage-namespaces" size="medium" lazy=false >}}

<!-- spellchecker-enable -->

Clicking on a namespace will allow you to drill down into that namespace and see the workloads (Spring Boot applications)
Clicking on a namespace will allow you to drill down into that namespace and see the workloads/microservices
deployed there.

#### Create Namespace
Expand All @@ -272,7 +272,7 @@ To delete one or more of the namesapces, select from the grid and click "DELETE"

### Manage Workloads

The Manage Workloads screen shows the workloads (Spring Boot applications) deployed in a specific namespace, including
The Manage Workloads screen shows the workloads/microservices deployed in a specific namespace, including
the status of each workload, and how many replicas are currently running and desired.

<!-- spellchecker-disable -->
Expand Down Expand Up @@ -378,7 +378,7 @@ To delete one or more workload, select and click "DELETE".

### Manage Identity

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 Spring Authorization Server included in the platform.
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.

<!-- spellchecker-disable -->

Expand Down Expand Up @@ -416,6 +416,16 @@ You can select a user and click "CHANGE ROLES" to add/remove roles.

<!-- spellchecker-enable -->

#### Change Email

You can select a user and click "CHANGE EMAIL" to change Email.

<!-- spellchecker-disable -->

{{< img name="soc-manage-identity-chg-email" size="medium" lazy=false >}}

<!-- spellchecker-enable -->

#### Delete User(s)

You can select one or more users and click "DELETE" to delete selected user(s).
Expand All @@ -438,7 +448,7 @@ The Collect Diagnostic Data is accessible from the Settings Menu and allows you

### Alerts

You can see preview of alerts from Alertmanager in Spring Operations Center. Clicking on an alert navigates to the Alertmanager UI. You can close individual alerts or click "Dismiss All" to close all the alerts. To re-enable the alerts, click "Show All Alerts" from the "Settings" menu.
You can see preview of alerts from Alertmanager in ServiceOps Center. Clicking on an alert navigates to the Alertmanager UI. You can close individual alerts or click "Dismiss All" to close all the alerts. To re-enable the alerts, click "Show All Alerts" from the "Settings" menu.

<!-- spellchecker-disable -->

Expand All @@ -448,7 +458,7 @@ You can see preview of alerts from Alertmanager in Spring Operations Center. Cli

### Usage Reporting

The Spring Operations Center can send basic install details to Oracle on a periodic basis, To enable that, click on the "AGREE" button on the notification or "CLOSE" to mute the notification. The details will include
The ServiceOps Center can send basic install details to Oracle on a periodic basis, To enable that, click on the "AGREE" button on the notification or "CLOSE" to mute the notification. The details will include

- Memory, CPU count, nodes and version of the Kubernetes cluster
- Overall health status of the OBaaS platform
Expand Down
Binary file modified docs-source/spring/content/platform/soc/soc-alerts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-create-ns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-delete-ns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-delete-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-delete-workload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-diag-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-forgot-passwd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-forgot-username.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-heartbeat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-login-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-manage-identity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-manage-workloads.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-source/spring/content/platform/soc/soc-reset-psswd.png
12 changes: 6 additions & 6 deletions docs-source/spring/content/release-notes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This release include:
- Optional GPU node pool
- Local install for development purposes
- OCI Free Tier install for development purposes
- Spring Operations Center (SOC) UI updates
- ServiceOps Center (SOC) UI updates
- Cloudbank version 4
- Addition of Alertmanager
- Version upgrades of components, see documentation for details
Expand All @@ -39,7 +39,7 @@ The following components were updated:

This release includes:

* Additional functionality to Spring Operations Center UI (SOC UI).
* Additional functionality to ServiceOps Center UI (SOC UI).
* Spring Boot upgrade to 3.3.0 and Spring Cloud 2023.0.2 for internal components.
* Oracle Backend for Microservices and AI are running Java 21 with Virtual Threads enabled.
* oractl is compiled using Java 21 and Virtual Threads.
Expand All @@ -65,7 +65,7 @@ The following components were updated:
| Oracle Transaction Manager for Microservices | 23.4.2 | 23.4.1 |
| Prometheus | 2.52.0 | 2.47.1 |
| Prometheus Operator | 0.74.0 | 0.63.0 |
| Spring Operations Center | 1.2.0 | 1.1.3 |
| ServiceOps Center | 1.2.0 | 1.1.3 |
| HashiCorp Vault | 1.16.1 | 1.15.2 |

{{< hint type=[warning] icon=gdoc_fire title="Deprecation Notice" >}}
Expand All @@ -91,14 +91,14 @@ This release includes small updates and/or bug fixes and some additional functio

## Version 1.1.1, February 9, 2024

This release adds the "Spring Operations Center" feature, adds or updates some Grafana dashboards, and includes
This release adds the "ServiceOps Center" feature, adds or updates some Grafana dashboards, and includes
other small updates and/or bug fixes.

The following components were added:

| Component | Version | Description |
|-----------------------------------------|-----------|----------------------------------------------------------|
| Spring Operations Center | 1.1.1 | Provide operations capabilities for Spring applications. |
| ServiceOps Center | 1.1.1 | Provide operations capabilities for Spring applications. |

The following components were updated:

Expand All @@ -112,7 +112,7 @@ Notes:

* Recommended versions for user applications updated Spring Boot 3.2.x, Java 17 or 21, Spring 6.1 and Spring Cloud 2023.0.0, with limited backwards compatibility for Spring Boot 2.7.x.
* Platform components are updated to Spring Boot 3.2.1 versions and matching Spring Cloud versions.
* A preview of a new "Spring Operations Center" feature is added, including a web user interface and additional Grafana dashboards.
* A preview of a new "ServiceOps Center" feature is added, including a web user interface and additional Grafana dashboards.
* User Management using the CLI and REST Endpoints.
* Added support for auto-scaling of Spring Boot applications deployed in the platform.
* Changes to the custom installation to allow using existing resources including database, network and Kubernetes.
Expand Down
6 changes: 3 additions & 3 deletions docs-source/spring/content/security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The Oracle Backend for Microservices and AI has the following security character

- All access to the database is done using the Mutual Transport Layer Security (mTLS) database wallet. The user name, password, and URL are stored in Kubernetes secrets.

- Accessing most dashboards can only be done using port-forwarding, the exceptions are the Spring Operations Center and Grafana, which can be accessed through the load balancer using TLS and appropriate authentication. The passwords for the dashboards are provided by the installer or autogenerated and stored in Kubernetes secrets.
- Accessing most dashboards can only be done using port-forwarding, the exceptions are the ServiceOps Center and Grafana, which can be accessed through the load balancer using TLS and appropriate authentication. The passwords for the dashboards are provided by the installer or autogenerated and stored in Kubernetes secrets.

- The only "public" exposure is the Apache APISIX Gateway (note that the dashboard is not exposed publicly), the Spring Operations Center and Grafana.
- The only "public" exposure is the Apache APISIX Gateway (note that the dashboard is not exposed publicly), the ServiceOps Center and Grafana.

- Services deployed to the platform are not exposed through the Apache APISIX Gateway automatically. If you want to expose the service through the gateway, you must define a route in the Apache APISIX dashboard. [APISIX Gateway Documentation](../platform/apigw)

Expand All @@ -26,7 +26,7 @@ The Oracle Backend for Microservices and AI has the following security character

## Transport Layer Security

The Oracle Backend for Microservices and AI is deployed with a sample self-signed certificate for Transport Layer Security (TLS). This results in an "Accept Risk" message when accessing the Spring Operations Center or Grafana web user interfaces and the sample TLS certificate should not be used for production deployments.
The Oracle Backend for Microservices and AI is deployed with a sample self-signed certificate for Transport Layer Security (TLS). This results in an "Accept Risk" message when accessing the ServiceOps Center or Grafana web user interfaces and the sample TLS certificate should not be used for production deployments.

### Updating the TLS Certificate

Expand Down
2 changes: 1 addition & 1 deletion docs-source/spring/data/menu/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ main:
- name: Platform Services
ref: "/platform"
sub:
- name: Spring Operations Center
- name: ServiceOps Center
ref : "/platform/soc"
- name: API Gateway
ref: "/platform/apigw"
Expand Down

0 comments on commit 5cac3a1

Please sign in to comment.