docs(nextcloud): migration guide (#9768)

**Description**
Migration guide for new Nextcloud. Please provide any inputs. A demo can
be seen at https://docs.kqmav.com/docs/nc-migration/migration-guide

⚒️ Fixes  #

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
Tested a few times, my nextcloud install is very basic though.

**📃 Notes:**

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
kqmaverick 2023-06-22 11:39:43 -07:00 committed by GitHub
parent 1ce8037d25
commit 7512cd1a38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 165 additions and 0 deletions

View File

@ -8,6 +8,7 @@ function check_version() {
# git diff target_branch, filter only on $chart_path and invert match for $chart_path/docs
# note that it requires branches to be up to date for this to work.
chart_changes=$(git diff --name-status "$target_branch" -- "$chart_path" | grep -v "$chart_path/docs")
echo -e "\tChange files: \n\n$chart_changes"
if [[ -z "$chart_changes" ]]; then
echo -e "\tLooks like only docs changed. Skipping chart version check"

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

View File

@ -0,0 +1,164 @@
# Nextcloud Migration Guide
This guide will walk you through the migration process for Nextcloud. This guide utilize HostPath or NFS for UserData.
:::danger TWO FACTOR AUTHENTICATION
If you are using two factor authentication on your Nextcloud accounts disable it before starting this guide. While it can be done via the CLI later it is much easier to disable it before hand.
:::
## Backup Nextcloud Database
If you have not already done so install PGAdmin and the [tcdbinfo.sh script](https://truecharts.org/manual/SCALE/guides/sql-export#how-to-list-database-login-info-for-truecharts-apps)
1. Run the tcdbinfo.sh script and take note of the connection info
```bash
bash tcdbinfo.sh
```
![tcdbinfo-output](./img/tcdbinfo-output.png)
2. Add Nextcloud to PGAdmin using the connection info from previous step.
![pgadmin-connection1](./img/pgadmin-connection1.png)
![pgadmin-connection2](./img/pgadmin-connection2.png)
3. Backup Nextcloud database.
![pgadmin-backup](./img/pgadmin-backup.png)
## Delete Nextcloud
:::danger Userdata Location
Do not remove your Nextcloud installation until you have confirmed you use HostPath/NFS for user data or have copied UserData using utilizing [Heavyscript](https://github.com/Heavybullets8/heavy_script)
:::
If you are using HostPath of NFS for UserData then remove your current Nextcloud installation. If you are using PVC for UserData then you will first need to mount your Nextcloud PVC and copy your UserData to a new dataset.
## Remove Old Nextcloud AppData
This step is not required but to have a clean installation remove all UserData folder and files that are not user folders.
```bash
ls -la
```
![userdata-old](./img/userdata-old.png)
:::warning
Next steps are destructive without a way to undo.
Make sure you have proper backups to avoid data loss.
You have been **warned**
```bash
rm -rf <folder>
```
```bash
rm .ocdata .htaccess index.html nextcloud.log
```
![userdata-clean](./img/userdata-clean.png)
:::
## Change UserData Permissions
The new version of Nextcloud uses apps instead of www-data for file ownership. Apply permissions as shown below to your UserData dataset.
![userdata-perms](./img/userdata-perms.png)
## Install Nextcloud
Install with a temporary user that you do not currently use for Nextcloud (ie. temp)
Setup Nextcloud UserData storage with your previous UserData dataset or the dataset you copied your UserData to.
![userdata-setting](./img/userdata-setting.png)
## Restore Nextcloud Database
:::caution Nextcloud Installation
Wait for Nextcloud to fully deploy before proceeding.
:::
1. Stop the main pod of Nextcloud.
```bash
k3s kubectl scale deploy nextcloud -n ix-nextcloud --replicas=0
```
2. Add Nextcloud to PGAdmin as guided in [steps 1 and 2 here](#backup-nextcloud-database).
3. In PGAdmin right click on the database and select restore as shown below.
![pgadmin-restore1](./img/pgadmin-restore1.png)
4. Select the database backup you created previously.
![pgadmin-restore2](./img/pgadmin-restore2.png)
5. Configure Data/Objects as shown below.
![pgadmin-restore3](./img/pgadmin-restore3.png)
6. Configure Options as shown below and click restore.
![pgadmin-restore4](./img/pgadmin-restore4.png)
:::caution PGAdmin Error
PGAdmin may display an error during the restore process. This is known to occur and may be ignored.
:::
7. Start the main pod of Nextcloud.
```bash
k3s kubectl scale deploy nextcloud -n ix-nextcloud --replicas=1
```
## Nextcloud OCC Commands
:::caution Nextcloud Deploy
Wait for Nextcloud to fully deploy before proceeding.
:::
1. Open a shell for the Nextcloud main pod as shown below. Ensure your are selecting the correct pod it should just say nextcloud for both Pods (followed by random characters only) and Containers as shown below.
![nextcloud-cli](./img/nextcloud-cli.png)
2. Run the following commands in the Nextcloud shell.
```bash
occ upgrade
```
```bash
occ maintenance:mode --on
```
```bash
occ maintenance:repair
```
```bash
occ maintenance:mode --off
```
```bash
occ db:add-missing-indices
```
```bash
occ files:scan --all
```
## Delete Temporary User Data Folder
You may now remove the folder created during install for the temporary user that was configured.