Skip to content

Commit e1c2612

Browse files
author
Zachary Leahan
committed
Update README to remove Helm references and focus on GitOps deployment
1 parent e2c5f7e commit e1c2612

File tree

1 file changed

+16
-33
lines changed

1 file changed

+16
-33
lines changed

choose-native-plants/README.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Choose Native Plants Application
22

3-
This README provides instructions for deploying and managing the Choose Native Plants application in the Kubernetes cluster using Helm.
3+
This README provides instructions for deploying and managing the Choose Native Plants application in the Kubernetes cluster using GitOps.
44

55
## Creating a New Release
66

@@ -24,37 +24,18 @@ git push origin main
2424
- Go to the [GitHub repository](https://github.com/CodeForPhilly/pa-wildflower-selector)
2525
- Click on the "Releases" tab
2626
- Click "Draft a new release"
27-
- Set the tag version to match your release (e.g., "v2.0.3")
28-
- Set the release title (e.g., "Choose Native Plants v2.0.3")
27+
- Set the tag version to match your release (e.g., "v2.0.4")
28+
- Set the release title (e.g., "Choose Native Plants v2.0.4")
2929
- Add release notes describing the changes in this version
3030
- Click "Publish release"
3131

3232
4. The GitHub Actions workflow will automatically build and push the new Docker image to the GitHub Container Registry with the specified tag.
3333

34-
## Deploying the Application with Helm
34+
## Deploying the Application to Sandbox
3535

36-
Once you've updated the release-values.yaml file and created a GitHub release, you can deploy the application using Helm:
36+
The sandbox environment uses a GitOps approach for deployments. When you push changes to the main branch of the cfp-sandbox-cluster repository, the deployment will be automatically triggered.
3737

38-
```powershell
39-
# Deploy or upgrade the application using Helm
40-
# Note: This only updates the deployment in the Kubernetes cluster, not your local repository
41-
helm upgrade --install choose-native-plants .\pa-wildflower-selector\helm-chart\ -f .\cfp-sandbox-cluster\choose-native-plants\release-values.yaml -n choose-native-plants
42-
```
43-
44-
**Important**: The `helm upgrade` command only affects your Kubernetes cluster deployment. It doesn't modify any files in your local repository. Make sure you've committed and pushed all changes to GitHub before running this command.
45-
46-
### Helm Release Management
47-
48-
```powershell
49-
# View release history
50-
helm history choose-native-plants -n choose-native-plants
51-
52-
# Rollback to a previous release if needed
53-
helm rollback choose-native-plants [REVISION] -n choose-native-plants
54-
55-
# View release status
56-
helm status choose-native-plants -n choose-native-plants
57-
```
38+
1. After updating the version in `release-values.yaml` and pushing to main, the GitOps process will detect the change and start a new deployment.
5839

5940
## Managing the Application
6041

@@ -109,23 +90,25 @@ $POD_NAME = kubectl get pods -n choose-native-plants -l app.kubernetes.io/name=c
10990
kubectl describe pod $POD_NAME -n choose-native-plants
11091
```
11192

112-
## CI/CD Integration with Helm
93+
## CI/CD Integration with GitOps
11394

114-
To integrate Helm into your CI/CD pipeline, update your deployment scripts to use Helm commands instead of direct kubectl commands. Here's a typical workflow:
95+
The sandbox environment uses a GitOps approach for deployments. Here's the typical workflow:
11596

11697
1. **Update Version**: Update the version in release-values.yaml as part of your CI process
117-
2. **Commit Changes**: Commit the updated release-values.yaml to your repository
118-
3. **Deploy with Helm**: Use the helm upgrade command in your deployment pipeline
98+
2. **Commit Changes**: Commit the updated release-values.yaml to the repository
99+
3. **Push Changes**: Push to the main branch to trigger the GitOps deployment
119100

120101
```powershell
121-
# Example CI/CD script
122-
$VERSION="2.0.3" # This would be dynamically set in your CI/CD process
102+
# Example CI/CD script to update version
103+
$VERSION="2.0.4" # This would be dynamically set in your CI/CD process
123104
124105
# Update the version in release-values.yaml
125106
(Get-Content .\cfp-sandbox-cluster\choose-native-plants\release-values.yaml) -replace 'tag: "\d+\.\d+\.\d+"', "tag: "$VERSION"" | Set-Content .\cfp-sandbox-cluster\choose-native-plants\release-values.yaml
126107
127-
# Deploy with Helm
128-
helm upgrade --install choose-native-plants .\pa-wildflower-selector\helm-chart\ -f .\cfp-sandbox-cluster\choose-native-plants\release-values.yaml -n choose-native-plants
108+
# Commit and push changes
109+
git add .\cfp-sandbox-cluster\choose-native-plants\release-values.yaml
110+
git commit -m "Update Choose Native Plants to version $VERSION"
111+
git push origin main
129112
```
130113

131114
## Accessing the Application

0 commit comments

Comments
 (0)