Skip to content

Commit

Permalink
Feature: improve documentation (#27)
Browse files Browse the repository at this point in the history
* fix: fixed bugs

* fix: fixed bugs
  • Loading branch information
YarikRevich authored Dec 9, 2024
1 parent e6dc833 commit f2d2fe9
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 6 deletions.
56 changes: 50 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,33 @@ service:
# Represents credentials used for the selected provider.
credentials:
# Represents session identificator, used to distinguish different workspaces and thus separate content inside.
id: "1"
id: "3"

# Represents a path to the credentials CSV file, which contains both access
# and secret keys.
file: "~/.aws/credentials"
# and secret keys. Make sure you don't use "~" symbol.
file: "/Users/objectstorage/.aws/credentials/rootkey.csv"

# Represents a select region where the deployment of infrastructure will be performed.
# Remember that it may influence the availability of the ObjectStorage deployed infrastructure.
#
# This option can be applied to "s3" provider only.
region: "us-west-2"

- provider: "gcs"

# Represents credentials used for the selected provider.
credentials:
# Represents session identificator, used to distinguish different workspaces and thus separate content inside.
id: "1"

# Represents a path to the credentials CSV file, which contains both access
# and secret keys. Make sure you don't use "~" symbol.
file: "/Users/objectstorage/.config/gcloud/application_default_credentials.json"

# Represents section used for ObjectStorage API Server configuration.
api-server:
# Represents address for the host of ObjectStorage API Server.
host: "http://localhost:8085"
host: "http://localhost:8086"
```
For **ObjectStorage API Server** there was used the following configuration file located at **~/.objectstorage/config** directory as **api-server.yaml**:
Expand Down Expand Up @@ -162,10 +174,42 @@ diagnostics:
In the **~/.objectstorage/internal/database** directory there will be located internal database data, if **sqlite3**
option is selected as target database.
> If **GCS** is selected, please make sure **Cloud Resource Manager API** service is enabled.
> Currently max object size is **1GB**. This limitation will be changed in the future.
### CLI
![cli](./docs/examples/cli.gif)
### Diagnostics dashboard
For **ObjectStorage API Server** configuration the following section should be modified:
```yaml
# Represents section used for ObjectStorage API Server diagnostics configuration.
diagnostics:
# Enables diagnostics functionality.
enabled: true

If GCS is selected, please make sure Cloud Resource Manager API is enabled.
# Represents section used for ObjectStorage diagnostics metrics configuration.
metrics:
# Represents port used for metrics endpoint.
port: 8090

# Represents section used for ObjectStorage diagnostics Grafana instance.
grafana:
# Represents port used for Grafana instance deployment.
port: 8091

# Represents section used for ObjectStorage diagnostics Prometheus instance.
prometheus:
# Represents port used for Prometheus instance deployment.
port: 8120

# Represents section used for ObjectStorage diagnostics Prometheus Node Exporter instance.
node-exporter:
# Represents port used for Prometheus Node Exporter instance deployment.
port: 8121
```
Currently max object size is 1GB, will be changed in the future.
![diagnostics](./docs/examples/diagnostics.gif)
Binary file added docs/examples/cli.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/diagnostics.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f2d2fe9

Please sign in to comment.