Startrekzky commented on code in PR #339: URL: https://github.com/apache/incubator-devlake-website/pull/339#discussion_r1039276254
########## docs/UserManuals/FAQ.md: ########## @@ -0,0 +1,55 @@ +--- +title: "FAQ" +sidebar_position: 10 +description: > + Frequently Asked Questions +--- + +## How to collect data from server with Self-Signed Certificate + +There might be two problems when trying to collect data from a private GitLab server with a self-signed certificate: + +1. "Test Connection" error. This can be solved by setting the environment variable `IN_SECURE_SKIP_VERIFY=true` for the `devlake` container +2. "GitExtractor" fails to clone the repository due to certificate verification, sadly, neither gogit nor git2go we are using supports insecure HTTPS. + +A better approach would be adding your root CA to the `devlake` container: + +1. Mount your `rootCA.crt` into the `devlake` container +2. Add a `command` node to install the mounted certificate + +Here is a example for the `docker-compose` installation, the idea is applicable for other kinds of installation. +``` + devlake: + image: apache/devlake:v... + ... + volumes: + ... + - /path/to/your/rootCA.crt:/usr/local/share/ca-certificates/rootCA.crt + command: [ "sh", "-c", "update-ca-certificates; lake" ] + ... +``` + + +## Pipeline failed with "The total number of locks exceeds the lock table size" + +We have had a couple of reports suggesting MySQL InnoDB would fail with the message. + +- [Error 1206: The total number of locks exceeds the lock table size · Issue #3849 · apache/incubator-devlake](https://github.com/apache/incubator-devlake/issues/3849) +- [[Bug][Gitlab] gitlab collectApiJobs task failed for mysql locks error · Issue #3653 · apache/incubator-devlake](https://github.com/apache/incubator-devlake/issues/3653) + +The cause of the problem is: + +- Before Apache DevLake data collection starts, it must purge expired data in the database. +- MySQL InnoDB Engine would create locks in memory for the records being deleted. +- When deleting huge amounts of records, the memory bursts, hence the error. + +You are likely to see the error when dealing with a huge repository or board. For MySQL, you can solve it by increasing the `innodb_buffer_pool_size` to a higher value. + +Here is a example for the `docker-compose` installation, the idea is applicable for other kinds of installation. +``` + mysql: + image: mysql:8..... + ... + # add the follow line to the mysql container + command: --innodb-buffer-pool-size=200M +``` Review Comment: Add a section or sentence to prompt the users who haven't found the answers to create an issue. ########## docs/UserManuals/ConfigUI/GitLab.md: ########## @@ -49,3 +49,9 @@ There are no transformation rules for GitLab repos. ### Step 4 - Setting Sync Frequency You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your prefered schedule. + + +## FAQ + +If you run into any problem, try finding the answer in [FAQ](../FAQ.md) Review Comment: If you run into any problems, please check the [FAQ](../FAQ.md) or create an [issue](https://github.com/apache/incubator-devlake/issues/new/choose). ########## docs/UserManuals/FAQ.md: ########## @@ -0,0 +1,55 @@ +--- +title: "FAQ" +sidebar_position: 10 +description: > + Frequently Asked Questions +--- + +## How to collect data from server with Self-Signed Certificate Review Comment: Should it be a question since it's FAQ? Such as: Failed to collect data from the server with a self-signed certificate. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
