Skip to content

Commit d90bc68

Browse files
authored
Support, Misc. Doco (#852)
* 132 from orahub
1 parent 87e590b commit d90bc68

File tree

23 files changed

+125
-8
lines changed

23 files changed

+125
-8
lines changed

docs-source/mbaas/content/setup/_index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,34 @@ The Oracle Backend for Parse Platform is deployed with a sample self-signed cert
107107
--type=merge
108108
```
109109

110+
## S3 Storage
111+
112+
During the initial Marketplace installation, there is an option to enable a S3 Compatible [Object Storage](https://www.oracle.com/uk/cloud/storage/object-storage/) bucket for external storage. This option can be enabled or disabled by editing and applying the installed Marketplace stack.
113+
114+
> **NOTE**: If changes to the infrastructure were made outside the stack, re-applying the stack may revert those changes back to their original values. It is important to *PLAN* and review the proposed changes before running *APPLY*. This will ensure there are no unintentional modifications to the infrastructure.
115+
116+
1. In the OCI Console, navigate to Developer Services -> Resource Manager -> Stacks
117+
![OCI Navigate Stacks](images/navigate_stacks.png "OCI Navigate Stacks")
118+
119+
2. Ensure the compartment is set to where the Marketplace Stack was deployed, and Select the stack.
120+
![OCI Select Stack](images/select_stack.png "OCI Select Stack")
121+
122+
3. Edit the Stack and Click Next
123+
![OCI Edit Stack](images/edit_stack.png "OCI Edit Stack")
124+
125+
4. Enable/Disable the S3 Storage
126+
![OCI S3 Storage](images/s3_storage.png "OCI S3 Storage")
127+
128+
5. Click Next and Save Changes
129+
![OCI Save Changes](images/save_changes.png "OCI Save Changes")
130+
131+
6. Run Plan
132+
![OCI Plan Changes](images/plan.png "OCI Plan Changes")
133+
134+
7. Carefully review the proposed changes
135+
![OCI Plan Output](images/plan_output.png "OCI Plan Output")
136+
137+
8. Run Apply after reviewing the proposed changes
138+
![OCI Apply Changes](images/apply.png "OCI Apply Changes")
139+
110140
Next, go to the [Microsoft Azure/OCI Multicloud Installation](../azure/) page to learn how to use the newly installed environment.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs-source/spring/content/support/_index.md renamed to docs-source/spring/content/get-help/_index.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Support"
2+
title: "Get Help"
33
description: "Get help for Oracle Backend for Spring Boot and Microservices"
44
keywords: "support backend oracle springboot spring development microservices database"
55
---
@@ -15,4 +15,34 @@ When asking for help please provide the following:
1515
- Which component(s) do you have an issue with?
1616
- If possible, provide a testcase that shows the issue.
1717

18+
## Diagnostics Collection
19+
20+
Two utilities will help Oracle diagnose and fix issues you may experience.
21+
22+
### Baseline
23+
24+
The [baseline script](https://github.com/oracle/microservices-datadriven/blob/main/support/baseline) will collect non-sensitive information about your cluster and can be used to compare the current cluster state with a baseline state. This will help to quickly identify any discrepancies between a stable deployment and the current deployments.
25+
26+
The baseline utility can be run in one of three modes:
27+
28+
#### Gather
29+
30+
`baseline`
31+
32+
This will write out a file `<VERSION>.json` by connecting to a kubernetes cluster and evaluating the current configuration. Use the `gather` option to establish a baseline of a working deployment.
33+
34+
#### Gather and Compare
35+
36+
`baseline --compare`
37+
38+
This will look for a file called `<OBAAS_VERSION>.json` and write out a new file `<OBAAS_VERSION>_current.json` of the current configuration. The two files will be compared for differences.
39+
40+
#### Compare
41+
42+
`baseline --compare <baselineFile> <currentFile>`
43+
44+
This will compare two existing files, generated by the utility.
45+
46+
### Cluster Dump
47+
1848
A script is [provided](https://github.com/oracle/microservices-datadriven/blob/main/support/collect-info.sh) which can help to collect information about the configuration of your environment, logs of platform services, and various other information that may be helpful to diagnose and fix issues. Usage of this script is optional, and you should be aware that it is possible, and likely, that the output of this script may contain private or sensitive information. If you choose to run the script, you *must* review the contents of the output *before* providing that output to Oracle or anyone else.

0 commit comments

Comments
 (0)