Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #223

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Documentation updates #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ theme:
- navigation.instant
- navigation.instant.preview
- navigation.tabs
- navigation.footer
# - navigation.tabs.sticky
# - navigation.sections
- navigation.expand
Expand Down Expand Up @@ -112,22 +113,34 @@ nav:
- Concepts:
- index.md
- getting_started.md
- Design:
- design_architecture.md
- design_infrastructure.md
- design_software.md
- Installation:
- install_prerequisites.md
- Features:
- feature_flags.md
- Services:
- services_overview.md
- services_source.md
- OSDU:
- services_core.md
- services_reference.md
- Core Services:
- services_core_partition.md
- services_core_entitlements.md
- services_core_legal.md
- services_core_schema.md
- services_core_storage.md
- services_core_indexer.md
- services_core_search.md
- services_core_file.md
- services_core_workflow.md
- Reference Services:
- services_reference_unit.md
- services_reference_crs.md
- services_reference_conversion.md
- Experimental:
- experimental_adminui.md
- Features:
- feature_flags.md
- Installation:
- install_prerequisites.md
- Design:
- design_architecture.md
- design_infrastructure.md
- design_software.md
- Tutorials:
- Deployment:
- tutorial_cli.md
Expand Down
41 changes: 41 additions & 0 deletions docs/src/services_core_entitlements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Entitlements

The entitlement service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: entitlements-v2-azure
Class: org.opengroup.osdu.entitlements.v2.azure.EntitlementsV2Application
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `APPINSIGHTS_KEY` | `<your_insights_key>` | Application Insights key |
| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI |
| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint |
| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID |
| `SERVER_PORT` | `8080` | HTTP Server Port |
| `SPRING_APPLICATION_NAME` | `entitlements` | Spring application name |
| `LOGGING_LEVEL` | `INFO` | Logging level for the Entitlements service |
| `SERVICE_DOMAIN_NAME` | `dataservices.energy` | Service domain name |
| `ROOT_DATA_GROUP_QUOTA` | `5000` | Root data group quota |
| `REDIS_TTL_SECONDS` | `1` | Redis TTL in seconds |
| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on |
| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD |



### Testing

The entitlement service can be tested locally in IntelliJ with the following run configuration

```
Build and Run Configuration: JUnit
---------------------------------------
Java SDK: Java zulu-17
Module: entitlementsv2-test-azure
All in package: org.opengroup.osdu.entitlements
```
26 changes: 26 additions & 0 deletions docs/src/services_core_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# File

The file service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: file-azure
Class: org.opengroup.osdu.file.provider.azure.FileAzureApplication
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `APPINSIGHTS_KEY` | `<your_appinsights_key>` | Application Insights key |
| `KEYVAULT_URI` | `<your_keyvault_uri>` | Key Vault URI |
| `AZURE_HOST` | `<your_host_ip>` | Azure host IP |
| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint |
| `OSDU_ENTITLEMENTS_URL` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint |
| `AAD_CLIENT_ID` | `<your_aad_client_id>` | Active Directory client ID |
| `SPRING_APPLICATION_NAME` | `file` | Spring application name |
| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity |
| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on |
| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled |
| `LOG_PREFIX` | `file` | Log prefix |
30 changes: 30 additions & 0 deletions docs/src/services_core_indexer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Indexer

The indexer service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: indexer-azure
Class: org.opengroup.osdu.indexer.azure.IndexerAzureApplication
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `APPINSIGHTS_KEY` | `<your_appinsights_key>` | Application Insights key |
| `KEYVAULT_URI` | `<your_keyvault_uri>` | Key Vault URI |
| `AZURE_HOST` | `<your_host_ip>` | Azure host IP |
| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint |
| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint |
| `SCHEMA_SERVICE_URL` | `http://${AZURE_HOST}/api/schema-service/v1` | Schema service endpoint |
| `STORAGE_SERVICE_URL` | `http://${AZURE_HOST}/api/storage/v2` | Storage service endpoint |
| `STORAGE_QUERY_RECORD_HOST` | `http://${AZURE_HOST}/api/storage/v2/query/records` | Storage service record query endpoint |
| `STORAGE_QUERY_RECORD_FOR_CONVERSION_HOST` | `http://${AZURE_HOST}/api/storage/v2/query/records:batch` | Storage service record batch query endpoint |
| `AAD_CLIENT_ID` | `<your_aad_client_id>` | Active Directory client ID |
| `SPRING_APPLICATION_NAME` | `indexer` | Spring application name |
| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity |
| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on |
| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled |
| `LOG_PREFIX` | `indexer` | Log prefix |
50 changes: 50 additions & 0 deletions docs/src/services_core_legal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Legal

The legal service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: legal-azure
Class: org.opengroup.osdu.legal.azure.LegalApplication
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `KV_NAME` | `<your_keyvault_name>` | Key Vault name |
| `AZURE_TENANT_ID` | `<your_tenant_id>` | Azure tenant ID |
| `AZURE_CLIENT_ID` | `<your_client_id>` | Azure client ID |
| `AZURE_CLIENT_SECRET` | `<your_client_secret>` | Azure client secret |
| `APPINSIGHTS_KEY` | `<your_insights_key>` | Application Insights key |
| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI |
| `AZURE_HOST` | `<your_host_ip>` | Azure host IP |
| `SPRING_APPLICATION_NAME` | `legal` | Spring application name |
| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID |
| `REDIS_DATABASE` | `2` | Redis database number |
| `SERVICEBUS_TOPIC_NAME` | `legaltags` | Service Bus topic name |
| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name |
| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | Entitlements service API key |
| `LEGAL_SERVICE_REGION` | `us` | Legal service region |
| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint |
| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint |
| `AZURE_ISTIO_AUTH_ENABLED` | `true` | Turn Istio auth on |
| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity |
| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled |
| `AZURE_ACTIVEDIRECTORY_APP_ID_URI` | `api://${AZURE_CLIENT_ID}` | Active Directory app ID URI |
| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD |



### Testing

The legal service can be tested locally in IntelliJ with the following run configuration

```
Build and Run Configuration: JUnit
---------------------------------------
Java SDK: Java zulu-17
Module: legal-test-azure
All in package: org.opengroup.osdu.legal
```
50 changes: 50 additions & 0 deletions docs/src/services_core_partition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Partition

The partition service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: partition-azure
Class: opengroup.osdu.partition.provider.azure.PartitionApplication
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

The following environment variables are necessary to run the Partition Service.


| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `APPINSIGHTS_KEY` | `<your_insights_key>` | Application Insights key |
| `KEYVAULT_URI` | `"https://<your_storage_name>.vault.azure.net"`| Key Vault URI |
| `AAD_CLIENT_ID` | `<your_client_id>` | Active Directory client ID |
| `SERVER_PORT` | `8080` | HTTP Server Port |
| `SPRING_APPLICATION_NAME` | `partition` | Spring application name |
| `REDIS_DATABASE` | `1` | Redis database number |
| `PARTITION_SPRING_LOGGING_LEVEL` | `INFO` | Logging level for the Partition service |
| `AZURE_ISTIOAUTH_ENABLED` | `false` | Turn Istio auth off |
| `AZURE_ACTIVEDIRECTORY_APP_ID_URI` | `api://<your_client_id>` | Active Directory app ID URI |
| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD |


### Testing

The partition service can be tested locally in IntelliJ with the following run configuration

```
Build and Run Configuration: JUnit
---------------------------------------
Java SDK: Java zulu-17
Module: partition-test-azure
All in package: org.opengroup.osdu.partition
```

| Variable | Value | Description |
|-----------------------------------------|------------------------------------------------|--------------------------------------------|
| `ENVIRONMENT` | `<your_environment>` | local or cloud |
| `AZURE_AD_TENANT_ID` | `<your_tenant_id>` | Azure tenant ID |
| `INTEGRATION_TESTER` | `<your_client_id>` | Azure client ID |
| `AZURE_TESTER_SERVICEPRINCIPAL_SECRET` | `<your_client_secret>` | Azure client secret |
| `AZURE_AD_APP_RESOURCE_ID` | `<your_client_id>` | Azure client ID |
| `PARTITION_BASE_URL` | `http://localhost:8080/` | Service URL |
39 changes: 39 additions & 0 deletions docs/src/services_core_schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Schema

The schema service can be run locally in editors with the following configuration.

```
Build and Run Configuration: SpringBoot
---------------------------------------
Java SDK: java zulu-17
Module: os-schema-azure
Class: org.opengroup.osdu.schema.azure.SchemaApplication
VM Options: -javaagent:/<your_full_path>/osdu-developer/src/applicationinsights-agent.jar
```

| Variable | Value | Description |
|--------------------------------------|------------------------------------------------|--------------------------------------------|
| `KV_NAME` | `<your_keyvault_name>` | Key Vault name |
| `STORAGE_ACCOUNT` | `<your_storage_account>` | Storage account name |
| `AZURE_TENANT_ID` | `<your_tenant_id>` | Azure tenant ID |
| `AZURE_CLIENT_ID` | `<your_client_id>` | Azure client ID |
| `AZURE_CLIENT_SECRET` | `<your_client_secret>` | Azure client secret |
| `APPINSIGHTS_KEY` | `<your_insights_key>` | Application Insights key |
| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI |
| `AZURE_HOST` | `<your_host_ip>` | Azure host IP |
| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint |
| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint |
| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID |
| `SPRING_APPLICATION_NAME` | `schema` | Spring application name |
| `LOG_PREFIX` | `schema` | Log prefix |
| `AZURE_STORAGE_ENABLE_HTTPS` | `true` | Enable HTTPS for Azure storage |
| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name |
| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | Entitlements service API key |
| `SERVER_PORT` | `8080` | Server port |
| `EVENT_GRID_ENABLED` | `false` | Enable Event Grid |
| `EVENT_GRID_TOPIC` | `schemachangedtopic` | Event Grid topic |
| `SERVICE_BUS_ENABLED` | `true` | Enable Service Bus |
| `SERVICEBUS_TOPIC_NAME` | `schemachangedtopic` | Service Bus topic name |
| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity |
| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on |
| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled |
Loading