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.

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

chore(docs): remove spanner related documentation #10057

Merged
merged 4 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 3 additions & 9 deletions docs/janssen-server/install/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ python3 /opt/jans/jans-setup/setup.py --help
```

```
usage: setup.py [-h] [--version] [-c] [-d D] [-f F] [-n] [-N] [-u] [-csx] [-encode-salt ENCODE_SALT] [-remote-rdbm {mysql,pgsql,spanner} | -local-rdbm {mysql,pgsql}] [-ip-address IP_ADDRESS]
usage: setup.py [-h] [--version] [-c] [-d D] [-f F] [-n] [-N] [-u] [-csx] [-encode-salt ENCODE_SALT] [-remote-rdbm {mysql,pgsql} | -local-rdbm {mysql,pgsql}] [-ip-address IP_ADDRESS]
[-host-name HOST_NAME] [-org-name ORG_NAME] [-email EMAIL] [-city CITY] [-state STATE] [-country COUNTRY] [-rdbm-user RDBM_USER] [-rdbm-password RDBM_PASSWORD] [-rdbm-port RDBM_PORT]
[-rdbm-db RDBM_DB] [-rdbm-host RDBM_HOST] [--reset-rdbm-db] [--shell] [--dump-config-on-error] [--no-progress] [-admin-password ADMIN_PASSWORD] [-jans-max-mem JANS_MAX_MEM]
[-properties-password PROPERTIES_PASSWORD] [-approved-issuer APPROVED_ISSUER] [--force-download] [--download-exit] [-jans-app-version JANS_APP_VERSION] [-jans-build JANS_BUILD]
Expand All @@ -84,8 +84,7 @@ usage: setup.py [-h] [--version] [-c] [-d D] [-f F] [-n] [-N] [-u] [-csx] [-enco
[-couchbase-default-mem COUCHBASE_DEFAULT_MEM] [-couchbase-user-mem COUCHBASE_USER_MEM] [-couchbase-site-mem COUCHBASE_SITE_MEM] [-couchbase-cache-mem COUCHBASE_CACHE_MEM]
[-couchbase-token-mem COUCHBASE_TOKEN_MEM] [-couchbase-session-mem COUCHBASE_SESSION_MEM] [--no-data] [--no-jsauth] [--no-config-api] [--no-scim] [--no-fido2] [--install-jans-ldap-link]
[--install-jans-keycloak-link] [--with-casa] [--install-jans-saml] [--install-jans-lock] [--install-opa] [--load-config-api-test] [-config-patch-creds CONFIG_PATCH_CREDS]
[-spanner-project SPANNER_PROJECT] [-spanner-instance SPANNER_INSTANCE] [-spanner-database SPANNER_DATABASE]
[-spanner-emulator-host SPANNER_EMULATOR_HOST | -google-application-credentials GOOGLE_APPLICATION_CREDENTIALS] [-test-client-id TEST_CLIENT_ID] [-test-client-pw TEST_CLIENT_PW]
[-test-client-id TEST_CLIENT_ID] [-test-client-pw TEST_CLIENT_PW]
[-test-client-redirect-uri TEST_CLIENT_REDIRECT_URI] [--test-client-trusted]
```

Expand All @@ -104,7 +103,7 @@ Below are the optional arguments:
| -N, --no-httpd | No apache httpd server |
| -u | Update hosts file with IP address / hostname |
| -csx | Collect setup properties, save and exit |
| -remote-rdbm {mysql,pgsql,spanner} | Enables using remote RDBM server |
| -remote-rdbm {mysql,pgsql} | Enables using remote RDBM server |
| -local-rdbm {mysql,pgsql} | Enables installing/configuring local RDBM server |
| -ip-address IP_ADDRESS | Used primarily by Apache httpd for the Listen directive |
| -host-name HOST_NAME | Internet-facing FQDN that is used to generate certificates and metadata. |
Expand Down Expand Up @@ -158,11 +157,6 @@ Below are the optional arguments:
| --load-config-api-test | Load Config Api Test Data |
| --install-cache-refresh | Install Cache Refresh Server |
| -config-patch-creds CONFIG_PATCH_CREDS | password:username for downloading auto test ciba password |
| -spanner-project SPANNER_PROJECT | Spanner project name |
| -spanner-instance SPANNER_INSTANCE | Spanner instance name |
| -spanner-database SPANNER_DATABASE | Spanner database name |
| -spanner-emulator-host SPANNER_EMULATOR_HOST | Use Spanner emulator host |
| -google-application-credentials GOOGLE_APPLICATION_CREDENTIALS | Path to Google application credentials json file |
| -test-client-id TEST_CLIENT_ID | ID of test client which has all available scopes. Must be in UUID format. |
| -test-client-pw TEST_CLIENT_PW | Secret for test client |
| -test-client-redirect-uri TEST_CLIENT_REDIRECT_URI | Redirect URI for test client |
Expand Down
2 changes: 0 additions & 2 deletions docs/janssen-server/install/vm-install/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,6 @@ Removing /etc/default/jans-auth
Stopping jans-auth
Removing /etc/default/jans-client-api
Stopping jans-client-api
Stopping OpenDj Server
Executing rm -r -f /etc/certs
Executing rm -r -f /etc/jans
Executing rm -r -f /opt/jans
Expand All @@ -184,7 +183,6 @@ Executing rm -r -f /opt/jre
Executing rm -r -f /opt/node*
Executing rm -r -f /opt/jetty*
Executing rm -r -f /opt/jython*
Executing rm -r -f /opt/opendj
Executing rm -r -f /opt/dist
Removing /etc/apache2/sites-enabled/https_jans.conf
Removing /etc/apache2/sites-available/https_jans.conf
Expand Down
7 changes: 2 additions & 5 deletions docs/janssen-server/reference/database/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ One of the main target of ORM module is to provide simple lightweight layer to a
Jans has next persistence modules out-of-the-box:

- [Couchbase](./cb-config.md)
- [Spanner](./spanner-config.md)
- [MySQL](./mysql-config.md)
- [PostgreSQL](./pgsql-config.md)
- [Hybrid](./pgsql-config.md). This is virtual DB layer which allows to combine few DB types based on record type.
Expand All @@ -36,7 +35,6 @@ on choice of persistence(DB) type, it can be one of these supported values:

- `couchbase`
- `sql`
- `spanner`
- `hybrid`.

!!! abstract "Code Connect"
Expand All @@ -50,7 +48,6 @@ the directory `/etc/jans/conf/`. List of configuration files for these
persistence types are:

- `jans-couchbase.properties`
- `jans-spanner.properties`
- `jans-sql.properties`
- `jans-hybrid.properties`

Expand Down Expand Up @@ -164,7 +161,7 @@ Jans ORM has modular architecture. The are few layers in this implementation

1. **jans-orm-standalone**: Provides reusable factory for non CDI based application

1. **jans-orm-ldap, jans-orm-couchbase, jans-orm-spanner, jans-orm-sql**: These are DB specific implementations.
1. **jans-orm-ldap, jans-orm-couchbase, jans-orm-sql**: These are DB specific implementations.


## Sample table and ORM API
Expand Down Expand Up @@ -293,4 +290,4 @@ schema [file](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/

It's possible to override default generation rules. For this case there is next [file](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/sql_data_types.json).

Default indexes defined in next files: [coubase_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/couchbase/index.json), [spanner_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/spanner_index.json), [mysql_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/mysql_index.json), [pgsql_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/pgsql_index.json)
Default indexes defined in next files: [coubase_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/couchbase/index.json), [mysql_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/mysql_index.json), [pgsql_index.json](https://github.com/JanssenProject/jans/blob/main/jans-linux-setup/jans_setup/static/rdbm/pgsql_index.json)
2 changes: 1 addition & 1 deletion docs/janssen-server/reference/database/mysql-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In order to support transparency for end applications and allow data migration f

Each table in **jansdb** MySQL schema follow next rules:

1. one table for every LDAP **objectClass**
1. one table for every **objectClass**
1. has 2 mandatory column `DN` and `doc_id`
1. Index for primary key

Expand Down
186 changes: 0 additions & 186 deletions docs/janssen-server/reference/database/spanner-config.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/janssen-server/reference/database/spanner-ops.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/janssen-server/reference/database/spanner-schema.md

This file was deleted.

4 changes: 0 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,6 @@ nav:
- MySQL Schema: janssen-server/reference/database/mysql-schema.md
- MySQL Configuration: janssen-server/reference/database/mysql-config.md
- MySQL Operation: janssen-server/reference/database/mysql-ops.md
- Spanner:
- Spanner Schema: janssen-server/reference/database/spanner-schema.md
- Spanner Configuration: janssen-server/reference/database/spanner-config.md
- Spanner Operation: janssen-server/reference/database/spanner-ops.md
- PostgreSQL:
- PostgreSQL Schema: janssen-server/reference/database/pgsql-schema.md
- PostgreSQL Indexes: janssen-server/reference/database/pgsql-schema-indexes.md
Expand Down