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
update to base module version. now using 1.2.1. renamed all admin to … (#166)
* update to base module version. now using 1.2.1. renamed all admin to operator
Signed-off-by: Ali Mukadam <[email protected]>
* Use latest for next release
* added tags in terraform.tfvars.example
@@ -145,11 +145,11 @@ If you need to change the default VCN's CIDR, note the following:
145
145
146
146
The bastion host parameters concern whether you want to enable the bastion.
147
147
148
-
=== Configure admin host parameters
148
+
=== Configure operator host parameters
149
149
150
-
The admin host parameters concern whether you want to enable the bastion. 1 parameter to keep in mind here is the admin_instance_principal. Be aware that if this is enabled, it gives API access to the admin host without authentication.
150
+
The operator host parameters concern whether you want to enable the bastion. 1 parameter to keep in mind here is the operator_instance_principal. Be aware that if this is enabled, it gives API access to the operator host without authentication.
151
151
152
-
Read {uri-instructions}#enabling-instance_principal-on-the-admin-host[more] about {uri-oci-instance-principal}[instance_principal].
152
+
Read {uri-instructions}#enabling-instance_principal-on-the-operator-host[more] about {uri-oci-instance-principal}[instance_principal].
153
153
154
154
{uri-terraform-options}#bastion-host[Reference]
155
155
@@ -223,8 +223,8 @@ The KMS integration parameters control whether {uri-oci-kms}[OCI Key Management
Copy file name to clipboardExpand all lines: docs/instructions.adoc
+31-31Lines changed: 31 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,11 +55,11 @@
55
55
. link:#creating-the-oke-cluster[Creating the OKE Cluster]
56
56
. link:#adding-the-bastion-host[Adding the bastion host]
57
57
. link:#using-the-bastion-host[Using the bastion host]
58
-
. link:#adding-the-admin-host[Adding the admin host]
59
-
.. link:#upgrading-the-admin-host[Upgrading the admin host]
60
-
. link:#using-the-admin-host[Using the admin host]
61
-
.. link:#enabling-instance_principal-on-the-admin-host[Enabling instance_principal on the admin host]
62
-
.. link:#disabling-instance_principal-on-the-admin-host[Disabling instance_principal on the admin host]
58
+
. link:#adding-the-operator-host[Adding the operator host]
59
+
.. link:#upgrading-the-operator-host[Upgrading the operator host]
60
+
. link:#using-the-operator-host[Using the operator host]
61
+
.. link:#enabling-instance_principal-on-the-operator-host[Enabling instance_principal on the operator host]
62
+
.. link:#disabling-instance_principal-on-the-operator-host[Disabling instance_principal on the operator host]
63
63
.. link:#recommendations-for-using-instance_principal[Recommendations for using instance_principal]
64
64
. link:#interacting-with-the-oke-cluster[Interacting with the OKE Cluster locally]
65
65
. link:#creating-a-secret-for-ocir[Creating a Secret for OCIR]
@@ -129,53 +129,53 @@ terraform output
129
129
130
130
You can then copy the ssh_to_bastion command, paste and run it in a terminal.
131
131
132
-
=== Adding the admin host
132
+
=== Adding the operator host
133
133
134
-
The admin host is used to minimize local dependencies such as oci-cli, kubectl and so on.
134
+
The operator host is used to minimize local dependencies such as oci-cli, kubectl and so on.
135
135
136
-
If you want to use the admin host, set the parameter *admin_enabled* to *true* in terraform.tfvars. Refer to {uri-terraform-options}#admin-host[Admin Host] for other available bastion related parameters.
136
+
If you want to use the operator host, set the parameter *operator_enabled* to *true* in terraform.tfvars. Refer to {uri-terraform-options}#operator-host[Admin Host] for other available bastion related parameters.
137
137
138
-
==== Upgrading the admin host
138
+
==== Upgrading the operator host
139
139
140
-
There is 1 additional parameter for the admin:
140
+
There is 1 additional parameter for the operator:
141
141
142
-
* admin_package_upgrade
142
+
* operator_package_upgrade
143
143
144
-
_admin_package_upgrade_ will upgrade the admin compute packages on first boot.
144
+
_operator_package_upgrade_ will upgrade the operator compute packages on first boot.
145
145
146
146
****
147
147
N.B. It is good and recommended practice to upgrade your package host to the latest packages to minimize the possibility of vulnerabilities. However, it will also take slightly longer before the package host is available.
148
148
****
149
149
150
-
=== Using the admin host
150
+
=== Using the operator host
151
151
152
152
****
153
-
*Assumption: you have set the admin_enabled parameter to true in terraform.tfvars*
153
+
*Assumption: you have set the operator_enabled parameter to true in terraform.tfvars*
154
154
****
155
155
156
-
Once the terraform apply is successful you will get the admin_private_ip as output and also a ssh command. You can also run the below command to get the output:
156
+
Once the terraform apply is successful you will get the operator_private_ip as output and also a ssh command. You can also run the below command to get the output:
157
157
158
158
----
159
159
terraform output
160
160
----
161
161
162
-
You can then copy the ssh_to_admin command, paste and run it in a terminal.
162
+
You can then copy the ssh_to_operator command, paste and run it in a terminal.
163
163
164
-
==== Enabling instance_principal on the admin host
164
+
==== Enabling instance_principal on the operator host
165
165
{uri-oci-instance-principal}[instance_principal] is an IAM service feature that enables instances to be authorized actors (or principals) to perform actions on service resources. Each compute instance has its own identity, and it authenticates using the certificates that are added to it. These certificates are automatically created, assigned to instances and rotated, preventing the need for you to distribute credentials to your hosts and rotate them.
166
166
167
167
Any user who has access to the instance (who can SSH to the instance), automatically inherits the privileges granted to the instance. Before you enable this feature, ensure that you know who can access it, and that they should be authorized with the permissions you are granting to the instance.
168
168
169
169
By default, this feature is *_disabled_*. However, it is *_required_* at the time of cluster creation *_if_* you wish to enable link:#kms-integration[KMS Integration], calico, metricserver, helm or creating the OCIR secret.
170
170
171
-
When you enable this feature, by default, the admin host will have privileges to all resources in the compartment. If you are enabling it for link:#kms-integration[KMS Integration], the admin host will also have rights to create policies in the root tenancy.
171
+
When you enable this feature, by default, the operator host will have privileges to all resources in the compartment. If you are enabling it for link:#kms-integration[KMS Integration], the operator host will also have rights to create policies in the root tenancy.
172
172
173
-
You can also turn on and off the feature at any time without impact on the admin or the cluster.
173
+
You can also turn on and off the feature at any time without impact on the operator or the cluster.
174
174
175
-
To enable, set admin_instance_principal to true:
175
+
To enable, set operator_instance_principal to true:
176
176
177
177
----
178
-
admin_instance_principal = "true"
178
+
operator_instance_principal = "true"
179
179
----
180
180
181
181
and verify:
@@ -184,13 +184,13 @@ and verify:
184
184
oci network vcn list --compartment-id <compartment-id>
185
185
----
186
186
187
-
==== Disabling instance_principal on the admin host
187
+
==== Disabling instance_principal on the operator host
188
188
189
-
. Set admin_instance_principal to false in terraform.tfvars
189
+
. Set operator_instance_principal to false in terraform.tfvars
190
190
191
191
+
192
192
----
193
-
admin_instance_principal = false
193
+
operator_instance_principal = false
194
194
----
195
195
196
196
. Run terraform apply again:
@@ -208,13 +208,13 @@ terraform apply
208
208
209
209
=== Interacting with the OKE Cluster
210
210
211
-
kubectl installed on the admin host by default and the kubeconfig file is set in the default location (~/.kube/config) so you don't need to set the KUBECONFIG environment variable every time you log in to the admin host.
211
+
kubectl installed on the operator host by default and the kubeconfig file is set in the default location (~/.kube/config) so you don't need to set the KUBECONFIG environment variable every time you log in to the operator host.
212
212
213
213
****
214
-
N.B. In order for kubeconfig to be created on the admin host, you need to link:#enabling-instance_principal-on-the-admin-host[enable instance_principal on the admin host].
214
+
N.B. In order for kubeconfig to be created on the operator host, you need to link:#enabling-instance_principal-on-the-operator-host[enable instance_principal on the operator host].
215
215
****
216
216
217
-
An alias "*k*" will be created for kubectl on the admin host.
217
+
An alias "*k*" will be created for kubectl on the operator host.
218
218
219
219
If you would like to use kubectl locally, {uri-install-kubectl}[install kubectl]. Then, set the KUBECONFIG to the config file path. The kubeconfig file will be saved generated locally under the folder *generated*:
220
220
@@ -241,17 +241,17 @@ Finally, assign the Secret OCID to *secret_id* in terraform.tfvars. Refer to {ur
241
241
242
242
=== Installing helm
243
243
244
-
{uri-helm}[Helm] is a package manager for kubernetes. If you want to install helm on the admin host, set the parameter *install_helm = true* in terraform.tfvars. By default, it is set to false.
244
+
{uri-helm}[Helm] is a package manager for kubernetes. If you want to install helm on the operator host, set the parameter *helm_enabled = true* in terraform.tfvars. By default, it is set to false.
245
245
246
-
An alias "*h*" will be created for helm on the admin host. For other available parameters, refer to {uri-terraform-options}#helm[Helm parameters].
246
+
An alias "*h*" will be created for helm on the operator host. For other available parameters, refer to {uri-terraform-options}#helm[Helm parameters].
247
247
248
248
=== Installing Calico
249
249
250
-
Calico enables network policy in Kubernetes clusters. To install calico set the parameter *install_calico = true* in terraform.tfvars. By default its set to false. Refer to {uri-terraform-options}#calico[Calico parameters] for other available parameters.
250
+
Calico enables network policy in Kubernetes clusters. To install calico set the parameter *calico_enabled = true* in terraform.tfvars. By default its set to false. Refer to {uri-terraform-options}#calico[Calico parameters] for other available parameters.
251
251
252
252
=== Installing Kubernetes Metrics Server
253
253
254
-
{uri-metricserver}[Kubernetes Metrics Server] can be installed by setting the parameter *install_metricserver = true* in terraform.tfvars. By default, the latest version is installed in kube-system namespace. This is required if you need to use Horizontal Pod Autoscaling.
254
+
{uri-metricserver}[Kubernetes Metrics Server] can be installed by setting the parameter *metricserver_enabled = true* in terraform.tfvars. By default, the latest version is installed in kube-system namespace. This is required if you need to use Horizontal Pod Autoscaling.
0 commit comments