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.

Sign up for GitHub

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

docs: Improve tutorial #947

Merged
merged 23 commits into from
Nov 8, 2024
Merged

docs: Improve tutorial #947

Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
162d325
move interfaces.go from interfaces to authtoken/providers directory a…
jamyct Oct 28, 2024
19ad9c2
Edit comments
jamyct Oct 28, 2024
78d0797
Rename structs, add periods to comments and update AuthToken comment
jamyct Oct 28, 2024
d989f31
remove pkg/interfaces to be copied from go source
jamyct Oct 28, 2024
f88c62e
Ran goimports -w on files in pkg/authtoken/providers/ directory
jamyct Oct 28, 2024
dee5042
Elaborate commenting for documentation
jamyct Oct 28, 2024
b7bfee7
Reorder imports by moving fleet pkgs to the bottom
jamyct Oct 28, 2024
10c7119
add test files
jamyct Nov 8, 2024
fd2e413
fix instructions to use crp-availability.yaml instead of crp.yaml
jamyct Nov 8, 2024
8382017
Merge branch 'main' into improve-tutorial
jamyct Nov 8, 2024
475a773
Add links to test files in tutorial
jamyct Nov 8, 2024
8bb76ac
Merge branch 'improve-tutorial' of github.com:jamyct/fleet into impro…
jamyct Nov 8, 2024
ceb1b92
add links to created test files where referenced in tutorial
jamyct Nov 8, 2024
c86070d
fix hyperlinks
jamyct Nov 8, 2024
cfd87ba
re-fix hyperlinks
jamyct Nov 8, 2024
394ce7c
re-fix hyperlinks
jamyct Nov 8, 2024
ca04ebb
re-fix hyperlinks directory spelling
jamyct Nov 8, 2024
0af9dee
Update docs/tutorials/MigrationWithOverrideDR.md
jamyct Nov 8, 2024
51db268
Update docs/tutorials/MigrationWithOverrideDR.md
jamyct Nov 8, 2024
fc88007
Update docs/tutorials/MigrationWithOverrideDR.md
jamyct Nov 8, 2024
9cf4699
use original crp
jamyct Nov 8, 2024
6e693b4
Merge branch 'improve-tutorial' of github.com:jamyct/fleet into impro…
jamyct Nov 8, 2024
ab28161
Add CR Override link and add extra lines at end of yaml files
jamyct Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/tutorials/MigrationWithOverrideDR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following resources are currently deployed in the WestUS clusters:

#### Service

Service test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-service.yaml] (https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-service.yaml)
Service test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-service.yaml] (./tesfiles/nginx-service.yaml)
britaniar marked this conversation as resolved.
Show resolved Hide resolved

```yaml
apiVersion: v1
Expand All @@ -40,7 +40,7 @@ Summary:

#### Deployment

Deployment test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-deployment.yaml] (https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-deployment.yaml)
Deployment test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/nginx-deployment.yaml] (./tesfiles/nginx-deployment.yaml)
britaniar marked this conversation as resolved.
Show resolved Hide resolved

```yaml
apiVersion: apps/v1
Expand Down Expand Up @@ -74,7 +74,7 @@ Summary:

#### ClusterResourcePlacement

CRP Availability test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/crp-availability.yaml] (https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/crp-availability.yaml)
CRP Availability test file located here: [https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/crp-availability.yaml] (./tesfiles/crp-availability.yaml)
britaniar marked this conversation as resolved.
Show resolved Hide resolved

```yaml
apiVersion: placement.kubernetes-fleet.io/v1
Expand Down Expand Up @@ -327,13 +327,13 @@ spec:
strategy:
type: RollingUpdate
```
Update the [`crp-availability.yaml`] (https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/crp-availability.yaml) to reflect selecting clusters with higher node-count and apply it:
Update the [`crp-availability.yaml`] (./tesfiles/crp-availability.yaml) to reflect selecting clusters with higher node-count and apply it:
britaniar marked this conversation as resolved.
Show resolved Hide resolved
```bash
kubectl apply -f crp-availability.yaml
```

### Results
After applying the updated [`crp-availability.yaml`] (https://github.com/Azure/fleet/blob/main/docs/tutorials/tesfiles/crp-availability.yaml), the Fleet will schedule the application on the available clusters in WestEurope as they each have 3 nodes.
After applying the updated [`crp-availability.yaml`] (./tesfiles/crp-availability.yaml), the Fleet will schedule the application on the available clusters in WestEurope as they each have 3 nodes.
britaniar marked this conversation as resolved.
Show resolved Hide resolved
You can check the status of the CRP to ensure that the application has been successfully migrated and is running in the new region:
```bash
kubectl get crp crp-availability -o yaml
Expand Down