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
Copy file name to clipboardexpand all lines: README.md
+74-4
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,25 @@ To facilite the usage of `crc-cloud`, a [container image](https://quay.io/reposi
28
28
29
29
### Authetication
30
30
31
-
All operations require to set the authentication mechanism in place. As so any `aws` authentication mechanism is supported by `crc-cloud`:
31
+
All operations require to set the authentication mechanism in place.
32
+
33
+
As so any `aws` authentication mechanism is supported by `crc-cloud`:
32
34
33
35
- long term credentials `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` as environment variables
34
36
- short lived credentials (in addition to `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` would require `AWS_SESSION_TOKEN`)
35
37
- credentials on config file (default file ~/.aws/config), in case of multiple profiles it will also accepts `AWS_PROFILE`
36
38
39
+
As so any `gcp` authentication mechanism is supported by `crc-cloud`:
40
+
41
+
- Credentials `GOOGLE_APPLICATION_CREDENTIALS` as environment variable
42
+
- Project ID `GCLOUD_PROJECT` as environment variable
43
+
- Region `GCLOUD_REGION` as environment variable
44
+
- Zone `GCLOUD_ZONE` as environment variable
45
+
37
46
### Restrictions
38
47
48
+
**Note**: `import` operation is not supported on `gcp` provider.
49
+
39
50
The `import` operation downloads and transform the bundle offered by crc into an image supported by `AWS`, as so there are some disk demanding operation. So there is a requirement of at least 70G free on disk to run this operation.
40
51
41
52
The AWS instance type of choice is *c6a.2xlarge* with 8vcpu and 16 GB of RAM. This will be customizable in the future, for the moment this fixed type imposes some [restrictions](https://aws.amazon.com/about-aws/whats-new/2022/12/amazon-ec2-m6a-c6a-instances-additional-regions/) on available regions to run crc cloud, those regions are:
@@ -98,7 +109,7 @@ podman run -d --rm \
98
109
99
110
`create` operation is responsible for create all required resources on the cloud provider to spin the Openshift Single Node Cluster.
100
111
101
-
Usage:
112
+
Usage: In case of `aws` provider
102
113
103
114
```bash
104
115
create crc cloud instance on AWS
@@ -121,6 +132,29 @@ Global Flags:
121
132
--pullsecret-filepath string path for pullsecret file
122
133
```
123
134
135
+
Usage: In case of `gcp` provider
136
+
137
+
```bash
138
+
create crc cloud instance on GCP
139
+
140
+
Usage:
141
+
crc-cloud create gcp [flags]
142
+
143
+
Flags:
144
+
--gcp-disk-size string Disk size in GB for the machine running the cluster. Default is 100.
145
+
--gcp-image-id string GCP image identifier
146
+
--gcp-instance-type string Instance typefor the machine running the cluster. Default is n1-standard-8.
147
+
-h, --help helpfor gcp
148
+
149
+
Global Flags:
150
+
--backed-url string backed for stack state. Can be a local path with format file:///path/subpath or s3 s3://existing-bucket
151
+
--key-filepath string path to init key obtained when importing the image
152
+
--output string path to export assets
153
+
--project-name string project name to identify the instance of the stack
154
+
--pullsecret-filepath string path for pullsecret file
155
+
--tags stringToString tags to add on each resource (--tags name1=value1,name2=value2) (default [])
156
+
```
157
+
124
158
Outputs:
125
159
126
160
-`kubeconfig` file with the kube config to connect withint the cluster
@@ -129,7 +163,7 @@ Outputs:
129
163
-`id_rsa` key to connect the remote host
130
164
-`password` password generated for `kubeadmin` and `developer` default cluster users
`destroy` operation will remove any resource created at the cloud provider, it uses the files holding the state of the infrastructure which has been store at location defined by parameter `backed-url` on `create` operation.
0 commit comments