fix(docs): remove Couchbase references (#10119)

* fix(docs): remove couchbase Signed-off-by: ossdhaval <[email protected]> * fix(docs): remove Couchbase references Signed-off-by: ossdhaval <[email protected]> --------- Signed-off-by: ossdhaval <[email protected]> Signed-off-by: Dhaval D <[email protected]>
JanssenProject · Nov 13, 2024 · b215e11 · b215e11
1 parent dd1478e
commit b215e11
Show file tree

Hide file tree

Showing 15 changed files with 31 additions and 373 deletions.
diff --git a/docs/contribute/implementation-design/jans-fido2.md b/docs/contribute/implementation-design/jans-fido2.md
@@ -13,7 +13,7 @@ FIDO2 as an open standard for authentication is based on public key cryptography
 Janssen's FIDO2 server - a component inside the Janssen project enables users of RPs to enroll and authenticate themselves using U2F keys, FIDO2 keys or inbuilt platform authenticator.
 1. The FIDO2 server uses REST endpoints to communicate with an RP via an https connection.
 2. The FIDO2 server implements the [FIDO Metadata Service (MDS3)](https://fidoalliance.org/metadata/metadata-service-overview/) defined by FIDO Alliance.
-3. The FIDO2 server stores user data into the same persistence store as the Jans-Auth server. (PostgreSQL, MYSQL, Couchbase etc.)
+3. The FIDO2 server stores user data into the same persistence store as the Jans-Auth server. (PostgreSQL, MYSQL etc.)
 
 ### Components of the FIDO2 ecosystem in Janssen
 

diff --git a/docs/janssen-server/config-guide/auth-server-config/couchbase-configuration.md b/docs/janssen-server/config-guide/auth-server-config/couchbase-configuration.md
diff --git a/docs/janssen-server/fido/README.md b/docs/janssen-server/fido/README.md
@@ -14,7 +14,7 @@ Janssen's FIDO2 server - a component inside the Janssen project enables users of
 
 1. The FIDO2 server uses REST endpoints to communicate with an RP via an https connection.
 2. The FIDO2 server implements the [FIDO Metadata Service (MDS3)](https://fidoalliance.org/metadata/metadata-service-overview/) defined by FIDO Alliance.
-3. The FIDO2 server stores user data into the same persistence store as the Jans-Auth server. (PostgreSQL, MYSQL, Couchbase etc.)
+3. The FIDO2 server stores user data into the same persistence store as the Jans-Auth server. (PostgreSQL, MYSQL etc.)
 
 Janssen's FIDO server is a standalone server communicates with the RP using an API which can be obtained by querying the following URL :
 

diff --git a/docs/janssen-server/install/README.md b/docs/janssen-server/install/README.md
@@ -31,8 +31,9 @@ configuration tool to perform any other last mile configuration.
 
 ## Databases
 
-The Janssen Project gives you a few options to store data: MySQL, Postgres,
-Couchbase, and Amazon Aurora. You can also configure an in-memory cache
+The Janssen Project gives you a few options to store data: MySQL, Postgres.
+MySQL is recommended for production deployments while Postgres for development. 
+You can also configure an in-memory cache
 server like Redis. Sometimes installation and configuration of this database
 is included in the setup process. Sometimes, you need to setup the database
 ahead of time. Please refer to the database instructions specific for your

diff --git a/docs/janssen-server/install/setup.md b/docs/janssen-server/install/setup.md
@@ -35,7 +35,7 @@ tags:
   Enter Password for Admin User:
   ```
   
-3. Next, pick a persistence mechanism. Choose from MySQL, PGSql that can be installed locally or remotely, or Couchbase, an enterprise NoSQL cloud database.
+3. Next, pick a persistence mechanism. Choose from MySQL, PGSql that can be installed locally or remotely.
     
 4. Next, pick which services should be installed for this deployment:
 
@@ -74,18 +74,22 @@ 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} | -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]
-                [-setup-branch SETUP_BRANCH] [--disable-config-api-security] [--cli-test-client] [--import-ldif IMPORT_LDIF] [-enable-script ENABLE_SCRIPT] [-disable-script DISABLE_SCRIPT]
-                [-java-version {11,17}] [-stm] [-w] [-t] [-x] [--allow-pre-released-features] [--remote-couchbase] [--local-couchbase] [-couchbase-admin-user COUCHBASE_ADMIN_USER]
-                [-couchbase-admin-password COUCHBASE_ADMIN_PASSWORD] [-couchbase-bucket-prefix COUCHBASE_BUCKET_PREFIX] [-couchbase-hostname COUCHBASE_HOSTNAME]
-                [-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]
-                 [-test-client-id TEST_CLIENT_ID] [-test-client-pw TEST_CLIENT_PW]
-                [-test-client-redirect-uri TEST_CLIENT_REDIRECT_URI] [--test-client-trusted]
+usage: jans_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]
+                     [-setup-branch SETUP_BRANCH] [--disable-config-api-security] [--cli-test-client]
+                     [--import-ldif IMPORT_LDIF] [-enable-script ENABLE_SCRIPT] [-disable-script DISABLE_SCRIPT]
+                     [-java-version {11,17}] [-stm] [-w] [-t] [-x] [--allow-pre-released-features] [--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]
+                     [-test-client-id TEST_CLIENT_ID] [-test-client-pw TEST_CLIENT_PW]
+                     [-test-client-redirect-uri TEST_CLIENT_REDIRECT_URI] [--test-client-trusted]
 ```
 
 Use this script to configure your Jans Server and to add initial data. If setup.properties is found in this folder, these properties will automatically be used instead of the interactive setup.
@@ -141,12 +145,6 @@ Below are the optional arguments:
 | -t | Load test data |
 | -x | Load test data and exit |
 | --allow-pre-released-features | Enable options to install experimental features, not yet officially supported |
-| --remote-couchbase | Enables using remote couchbase server |
-| --local-couchbase | Enables installing couchbase server |
-| -couchbase-admin-user COUCHBASE_ADMIN_USER | Couchbase admin user |
-| -couchbase-admin-password COUCHBASE_ADMIN_PASSWORD | Couchbase admin user password |
-| -couchbase-bucket-prefix COUCHBASE_BUCKET_PREFIX | Set prefix for couchbase buckets |
-| -couchbase-hostname COUCHBASE_HOSTNAME | Remote couchbase server hostname |
 | --no-data | Do not import any data to database backend, used for clustering |
 | --no-jsauth | Do not install OAuth2 Authorization Server |
 | --no-config-api | Do not install Jans Auth Config Api |

diff --git a/docs/janssen-server/planning/caching.md b/docs/janssen-server/planning/caching.md
@@ -4,7 +4,6 @@ tags:
   - planning
   - caching
   - Redis
-  - Couchbase
   - Memcached
 ---
 
@@ -23,13 +22,9 @@ switch to another cache mechanism.
 want another component or service, but you need the session replication for a
 cluster, it may be convenient to persist the "cache" data in the database.
 
-1. **Couchbase**  If you are already using Couchbase for persistence, then
-Janssen Auth Server can use "ephemeral buckets", which exist only in memory,
-for caching.
-
-1. **Redis** The best choice if you need a cache service for RDBMS. Great performance
-and low cache miss rate. Commercial Redis supports TLS, which is a good option if you 
-need secure communication.
+1. **Redis** The best choice if you need a cache service for RDBMS,
+or Spanner. Great performance and low cache miss rate. Commercial Redis
+supports TLS, which is a good option if you need secure communication.
 
 1. **Memcached** Still a good choice, especially if that's what you already
 run for other applications. We have observed a slightly higher cache miss

diff --git a/docs/janssen-server/planning/components.md b/docs/janssen-server/planning/components.md
@@ -18,9 +18,8 @@ assertions. This service must be Internet-facing.
 1. **Database**: Like most IAM platforms, Janssen requires some kind of
 persistence service to store configuration and other entity data (client,
 person, scope, attribute, FIDO device, etc.) As different databases are
-good for different deployments, Janssen supports a number of options:
-MySQL, Postgres, Couchbase, and Amazon Aurora. Other
-databases may be added in the future.
+good for different deployments, Janssen supports MySQL and Postgres.
+
 
 1. **Cache**: Getting data from a disk is still the slowest part of any
 web platform. If you want higher transaction speeds, one strategy is to

diff --git a/docs/janssen-server/planning/persistence.md b/docs/janssen-server/planning/persistence.md
@@ -4,7 +4,6 @@ tags:
   - planning
   - persistence
   - MySQL
-  - Couchbase
   - Aurora
   - Postgres
   - database
@@ -35,12 +34,6 @@ you'll have to figure out a plan for replication, and horizontal scaling.
 distributions of Postgres like [EnterpriseDB](https://www.enterprisedb.com/). **Postgres is our default 
 persistence for VM based non-production deployments**.
 
-1. **Couchbase** A JSON NoSQL database that supports automatic distribution
-of data for auto-scaling multi-region sharded cloud-native deployments. Janssen
-only supports the commercial distribution--but the previously mentioned database
-properties are enterprise class. If you need to host your own database, and you
-need infinite horizontal scalability, Couchbase should be your go-to choice.
-
 1. **Aurora** So you want MySQL, but you want Amazon to handle some of the care
 and feeding? Aurora enables you to consume database as a cloud service.
 Scalability is excellent and multi-region deployments are [possible](https://aws.amazon.com/blogs/database/deploy-multi-region-amazon-aurora-applications-with-a-failover-blueprint/).

diff --git a/docs/janssen-server/reference/database/cb-buckets.md b/docs/janssen-server/reference/database/cb-buckets.md