You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*To deploy, you will need to have these roles on the *organization* where Iris is deployed.
79
+
*For the first deployment, to set up roles and log sink. You will need to have these roles on the *organization* where Iris is deployed. These are not needed for subsequent deployments.
80
80
**Organization Role Administrator* to create a custom IAM role for Iris that allows to get and set labels on the
81
81
services.
82
82
(Note that this is different from *Organization Administrator* and from Organization *Owner*.)
83
83
**Security Admin* OR *Organization Administrator* to allow Iris app engine service account to use the above role
84
84
**Logs Configuration Writer* to create an organization log sink that sends logs to PubSub
85
85
86
-
*On the project where Iris is deployed, you will need Owner or these roles:
86
+
*To deploy Iris itself, you will need Owner on the project where Iris is deployed, or else these roles. (To deploy only Iris itself after the org elements are already deployed, use `-p` as documented below.)
87
87
**Project IAM Admin* to set up the custom role as mentioned above.
88
88
**App Engine Admin* to deploy to App Engine.
89
89
**Pub/Sub Admin* to create topics and subscriptions.
@@ -103,13 +103,18 @@ through [this tutorial](https://cloud.google.com/appengine/docs/standard/python3
103
103
* Have Python 3.9+ as your default `python3`.
104
104
* Install tools `envsubst` and `jq`.
105
105
* Install and initialize `gcloud` using an account with the [above-mentioned](#before-deploying) roles.
106
-
* Copy `config.yaml.original` to `config.yaml`.
107
-
* Optionally configure by editing the configuration files ([See more documentation below](#configuration).)
108
-
* Run `./deploy.sh <PROJECT_ID>`.
109
-
* To use *only* Cloud Scheduler cron (i.e., without labeling resources on-creation), put `-c` at the end of the
110
-
command line.
111
-
* For the opposite, to label resources on-creation and *not* label with Cloud Scheduler, thus saving the costs of
112
-
iterating over all resources, see below re the `label_all_on_cron` setting in the configuration file.
106
+
* Config
107
+
* Copy `config.yaml.original` to `config.yaml`.
108
+
* Optionally configure by editing the configuration files ([See more documentation below](#configuration).)
109
+
* Run `./deploy.sh <PROJECT_ID> `.
110
+
* The above is the default. There are also command-line options, to be put at the end of the command line after the project id.
111
+
* Org and project
112
+
* Use `-o -p` to deploy org elements and also project elements. If you omit both, then the default behavior is to deploy both, as if `-o -p` were given.
113
+
* Use `-o` to deploy only org elements like roles and log sinks. You might want to do this if you have different people controlling the org and the project.
114
+
* Once org elements are set up, only `-p` is needed, to deploy the Iris app to App Engine
115
+
* Cloud Scheduler
116
+
* To use *only* Cloud Scheduler cron (i.e., without labeling resources on-creation), also use `-c`.
117
+
* To *not at all* use Cloud Scheduler, delete schedule in `cron.yaml`.
113
118
* When you redeploy different versions of Iris code on top of old ones:
114
119
* If new plugins were added or some removed, the log sink *will* be updated to reflect this.
115
120
* If the parameters for subscriptions or topics were changed in a new version of the Iris code, the subscriptions or
@@ -125,7 +130,7 @@ through [this tutorial](https://cloud.google.com/appengine/docs/standard/python3
125
130
* otherwise `config.yaml` is used.
126
131
* Local vs App Engine
127
132
* `config-dev.yaml` is not uploaded to App Engine and so is ignored there.
128
-
* `config-test.yaml` and `config.yaml` are available for use in App Engine.
133
+
* `config-test.yaml` and `config.yaml` are available for use in App Engine.
129
134
* Copy `config.yaml.original` to the desired file name
130
135
* All values in the `config*.yaml` are optional.
131
136
*`app.yaml` lets you configure App Engine, for example to set a maximum number of instances. See App Engine
0 commit comments