Skip to content

doc: Add external NFS setup instructions DOCS-393#745

Merged
prcr merged 9 commits into
masterfrom
doc/configure-external-nfs-DOCS-393
Jul 19, 2022
Merged

doc: Add external NFS setup instructions DOCS-393#745
prcr merged 9 commits into
masterfrom
doc/configure-external-nfs-DOCS-393

Conversation

@prcr

@prcr prcr commented Jul 15, 2022

Copy link
Copy Markdown
Contributor

Adds instructions on how to configure Codacy Self-hosted to mount an NFS volume on an external server.

👀 Live preview

https://feature-update-chart--docs-codacy.netlify.app/chart/configuration/caching/

@prcr
prcr marked this pull request as ready for review July 15, 2022 15:09
prcr pushed a commit to codacy/docs that referenced this pull request Jul 15, 2022
@prcr
prcr force-pushed the doc/configure-external-nfs-DOCS-393 branch from 101a38b to 3e60d0f Compare July 15, 2022 15:14
prcr pushed a commit to codacy/docs that referenced this pull request Jul 15, 2022
@prcr
prcr requested review from h314to and heliocodacy July 15, 2022 15:26
prcr pushed a commit to codacy/docs that referenced this pull request Jul 15, 2022
Comment thread README.md
Comment on lines +188 to +191
| `listener.cache.name` | External NFS volume name | `listener-cache` |
| `listener.cache.path` | External NFS volume mount path | `/data` |
| `listener.cache.nfs.server` | IP address of external NFS server | `0.0.0.0` |
| `listener.cache.nfs.path` | External NFS server directory or file system to be mounted | `/` |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I obtained the default values from the repository-listener repository.


# Caching

Codacy Self-hosted includes a built-in NFS server provisioner that deploys a shared volume to cache the cloned repository files while they're being analyzed by each tool. However, if you're dealing with big repositories or a high volume of analysis, using an NFS server external to the cluster will improve the performance of the cache.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check/validate the rationale for setting up an external NFS server instead of using the built-in one.

heliocodacy
heliocodacy previously approved these changes Jul 15, 2022
prcr pushed a commit to codacy/docs that referenced this pull request Jul 15, 2022
@prcr
prcr merged commit 0510d27 into master Jul 19, 2022
@prcr
prcr deleted the doc/configure-external-nfs-DOCS-393 branch July 19, 2022 11:13
prcr pushed a commit to codacy/docs that referenced this pull request Jul 19, 2022
prcr pushed a commit to codacy/docs that referenced this pull request Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants