-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change value names to be more Helm idiomatic, and
clarify README documentation, and bump Helm Chart version number, and This _partially_ reverts commit 48e8e90.
- Loading branch information
1 parent
328477d
commit 1e606b6
Showing
4 changed files
with
25 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
@@ -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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,10 @@ global: | |
redis: | ||
password: ChangeMeNow | ||
uffizzi: | ||
firstUser: | ||
email: "" | ||
password: "" | ||
projectName: default | ||
controller: | ||
username: username | ||
password: ChangeMeNow | ||
|
@@ -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" | ||
|