47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# aws-iam interface
|
|
|
|
This interface provides communication between
|
|
[kubernetes-control-plane](https://github.com/charmed-kubernetes/charm-kubernetes-master)
|
|
and [aws-iam](https://github.com/charmed-kubernetes/charm-aws-iam)
|
|
subordinate.
|
|
|
|
It allows the requires side, aws-iam, to know when the api server is
|
|
up and available and to tell the api server when the webhook.yaml
|
|
file is written so that it may restart and use the webhook.
|
|
|
|
## Provides (kubernetes-control-plane side)
|
|
|
|
### States
|
|
* `aws-iam.available`
|
|
Indicates that there are one or more units on the other side
|
|
of the relation
|
|
* `aws-iam.ready`
|
|
Indicates that the webhook status has been set. This is used
|
|
to indicate it is time to restart the API server to pick up
|
|
the webhook config on the Kubernetes side.
|
|
### Methods
|
|
* `get_cluster_id`
|
|
The AWS-IAM charm generates a random cluster ID for the cluster
|
|
that is needed in the kubectl configuration file. This is
|
|
retrieved from the relation here.
|
|
* `set_api_server_status`
|
|
This is set to indicate if the Kubernetes API server is up and
|
|
ready for connections. This is needed because the aws-iam charm
|
|
needs to set up the service it will use in order to add the IP
|
|
to the extra sans in the ssl certificate used to secure
|
|
communication between the control-plane and the service.
|
|
|
|
## Requires (aws-iam side)
|
|
|
|
### States
|
|
* `aws-iam.available`
|
|
Indicates that there are one or more units on the other
|
|
side of the relation
|
|
### Methods
|
|
* `set_cluster_id`
|
|
The AWS-IAM charm generates a random cluster ID for the
|
|
cluster that is needed in the kubectl configuration file.
|
|
This is passed over the relation here.
|
|
* `set_webhook_status`
|
|
Called to set that the webhook configuration has been written
|
|
to disk. |