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

Conversation

ossdhaval
Copy link
Contributor

@ossdhaval ossdhaval commented Nov 6, 2024

Please edit this.
Closes #10058,

@ossdhaval ossdhaval self-assigned this Nov 6, 2024
@ossdhaval ossdhaval requested a review from moabu as a code owner November 6, 2024 07:40
Copy link

dryrunsecurity bot commented Nov 6, 2024

DryRun Security Summary

The pull request primarily focuses on the removal of support for the Google Cloud Spanner database in the Janssen Server project, which simplifies the deployment options, reduces the potential attack surface, and improves the security, maintainability, and configurability of the project.

Expand for full summary

Summary:

The changes in this pull request primarily focus on the removal of support for the Google Cloud Spanner database in the Janssen Server project. This includes updates to the installation and configuration documentation, as well as the removal of Spanner-related files and references throughout the codebase. From an application security perspective, the removal of Spanner support is a positive change, as it simplifies the deployment options and reduces the potential attack surface by eliminating a relatively new and complex database service.

The changes also include updates to the MySQL configuration documentation, which highlight the use of secure practices, such as password hashing and connection pool management. Additionally, the uninstallation process for the Janssen Server appears to be thorough, ensuring that all components and configuration files are properly removed. However, the handling of the persistence store during uninstallation should be further investigated to ensure that any sensitive data is properly managed and secured.

Overall, the changes in this pull request seem to be focused on improving the security, maintainability, and configurability of the Janssen Server project, which is a positive step from an application security perspective.

Files Changed:

  1. docs/janssen-server/install/setup.md: The changes remove the spanner option from the -remote-rdbm argument and the spanner-* related arguments, indicating the removal of Spanner support.
  2. docs/janssen-server/reference/database/README.md: The changes remove references to the Spanner configuration file, the jans-orm-spanner module, and the spanner_index.json file, further confirming the removal of Spanner support.
  3. docs/janssen-server/install/vm-install/ubuntu.md: The changes outline the uninstallation process for the Janssen Server, which includes the removal of various components and associated files. This is a positive security practice, but the handling of the persistence store during uninstallation should be further investigated.
  4. docs/janssen-server/reference/database/mysql-config.md: The changes update the documentation for the MySQL configuration, highlighting the use of secure practices, such as password hashing and connection pool management.
  5. mkdocs.yml: The changes remove the Spanner-related configuration files from the mkdocs.yml file, further confirming the removal of Spanner support.

Code Analysis

We ran 9 analyzers against 8 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@ossdhaval ossdhaval linked an issue Nov 6, 2024 that may be closed by this pull request
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-pycloudlib kind-dependencies Pull requests that update a dependency file labels Nov 6, 2024
@mo-auto
Copy link
Member

mo-auto commented Nov 6, 2024

Error: Hi @ossdhaval, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

Copy link

sonarcloud bot commented Nov 6, 2024

@ossdhaval ossdhaval enabled auto-merge (squash) November 6, 2024 10:30
@ossdhaval ossdhaval merged commit cdfd022 into main Nov 6, 2024
13 checks passed
@ossdhaval ossdhaval deleted the docs-remove-spanner branch November 6, 2024 15:27
@ossdhaval ossdhaval restored the docs-remove-spanner branch November 7, 2024 07:02
@ossdhaval ossdhaval deleted the docs-remove-spanner branch November 7, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-pycloudlib kind-dependencies Pull requests that update a dependency file
Projects
None yet
4 participants