Skip to content

Commit

Permalink
Change value names to be more Helm idiomatic, and
Browse files Browse the repository at this point in the history
clarify README documentation, and
bump Helm Chart version number, and
This _partially_ reverts commit 48e8e90.
  • Loading branch information
axisofentropy authored and moklidia committed Jun 6, 2022
1 parent 328477d commit 1e606b6
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 11 deletions.
2 changes: 1 addition & 1 deletion charts/uffizzi-app/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: uffizzi-app
version: 1.1.3
version: 1.2.0
kubeVersion: ">= 1.21.0-0" # https://issuetracker.google.com/issues/77503699
description: "Uffizzi is an open-source engine for creating lightweight, ephemeral test environments for APIs and full-stack applications. Uffizzi enables teams to preview new features before merging."
type: application
Expand Down
21 changes: 17 additions & 4 deletions charts/uffizzi-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,23 +55,23 @@ global:
redis:
password: ChangeMeNow
uffizzi:
firstUser:
email: [email protected]
password: ChangeMeNow
controller:
password: ChangeMeNow
app_url: https://uffizzi.example.com
webHostname: uffizzi.example.com
allowed_hosts: uffizzi.example.com
managed_dns_zone_dns_name: uffizzi.example.com
uffizzi_user_email: [email protected]
uffizzi_user_password: ChangeMeNow
uffizzi-controller:
ingress:
hostname: controller.uffizzi.example.com
clusterIssuer: "letsencrypt"
certEmail: [email protected]
```
Edit these values and save them in a file named `myvals.yaml` or similar.
The "uffizzi_user_email" and "uffizzi_user_password" are used for the default user creation, which is needed to access your Uffizzi installation.
Edit these values and save them in a file named `myvals.yaml` or similar.

## Installation

Expand Down Expand Up @@ -106,6 +106,19 @@ kubectl get ingress --namespace uffizzi
Be sure to add a "wildcard" record for the domain specified in `managed_dns_zone_dns_name`. In the above example, that's `*.uffizzi.example.com`.
### Provisioning users
You'll need to create at least one User Account to access your Uffizzi installation. The easiest way to do this is specify values for `global.uffizzi.firstUser` as shown in the example values file above. Uffizzi will attempt to provision this User each time it starts.
If you did not specify a `firstUser`, or if you want to provision additional Users, you may execute an interactive `rake` task within the application server container:
```
kubectl exec -it deploy/my-uffizzi-app-web --namespace uffizzi -- rake uffizzi_core:create_user
Enter User Email (default: [email protected]): [email protected]
Enter Password:
Enter Project Name (default: default):
```
## Usage
If everything went well, you can now connect to the Uffizzi API service and begin Continously Deploying Previews! Use [the Uffizzi CLI](https://github.com/UffizziCloud/uffizzi_cli) or [the Uffizzi GitHub Action](https://github.com/UffizziCloud/preview-action) or your own API client.
Expand Down
6 changes: 3 additions & 3 deletions charts/uffizzi-app/templates/configmap-common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ data:
CONTROLLER_URL: {{ default (print "http://" .Release.Name "-controller:8080") .Values.controller_url }}
EMAIL_DELIVERY_ENABLED: {{ .Values.feature_email_delivery | quote }}
MANAGED_DNS_ZONE_DNS_NAME: {{ .Values.managed_dns_zone_dns_name | quote }}
UFFIZZI_USER_EMAIL: {{ .Values.uffizzi_user_email }}
UFFIZZI_USER_PASSWORD: {{ .Values.uffizzi_user_password | quote }}
UFFIZZI_PROJECT_NAME: {{ .Values.uffizzi_project_name }}
UFFIZZI_USER_EMAIL: {{ .Values.global.uffizzi.firstUser.email }}
UFFIZZI_USER_PASSWORD: {{ .Values.global.uffizzi.firstUser.password | quote }}
UFFIZZI_PROJECT_NAME: {{ .Values.global.uffizzi.firstUser.projectName | quote }}
7 changes: 4 additions & 3 deletions charts/uffizzi-app/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ global:
redis:
password: ChangeMeNow
uffizzi:
firstUser:
email: ""
password: ""
projectName: default
controller:
username: username
password: ChangeMeNow
Expand Down Expand Up @@ -42,9 +46,6 @@ feature_email_delivery: false
feature_google_maps: false
feature_sentry: false
feature_stripe: false
uffizzi_user_email: [email protected]
uffizzi_user_password: ""
uffizzi_project_name: default

uffizzi-controller: #dependency
clusterIssuer: "letsencrypt"
Expand Down

0 comments on commit 1e606b6

Please sign in to comment.