mirror of
https://github.com/storytold/irsa-manager.git
synced 2026-10-23 08:05:25 +00:00
fix readme
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# irsa-manager
|
# IRSA Manager
|
||||||
|
|
||||||
irsa-manager allows you to easily set up IAM Roles for Service Accounts (IRSA) on non-EKS Kubernetes clusters.
|
IRSA Manager allows you to easily set up IAM Roles for Service Accounts (IRSA) on non-EKS Kubernetes clusters.
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ Follow these steps to set up IRSA on your non-EKS cluster:
|
|||||||
|
|
||||||
Add the irsa-manager Helm repository and install irsa-manager:
|
Add the irsa-manager Helm repository and install irsa-manager:
|
||||||
|
|
||||||
```
|
```console
|
||||||
helm repo add kkb0318 https://kkb0318.github.io/irsa-manager
|
helm repo add kkb0318 https://kkb0318.github.io/irsa-manager
|
||||||
helm repo update
|
helm repo update
|
||||||
helm install irsa-manager kkb0318/irsa-manager -n irsa-manager-system --create-namespace
|
helm install irsa-manager kkb0318/irsa-manager -n irsa-manager-system --create-namespace
|
||||||
@@ -36,7 +36,7 @@ helm install irsa-manager kkb0318/irsa-manager -n irsa-manager-system --create-n
|
|||||||
|
|
||||||
Create a secret for irsa-manager to access AWS:
|
Create a secret for irsa-manager to access AWS:
|
||||||
|
|
||||||
```
|
```console
|
||||||
kubectl create secret generic aws-secret -n irsa-manager-system \
|
kubectl create secret generic aws-secret -n irsa-manager-system \
|
||||||
--from-literal=aws-access-key-id=<your-access-key-id> \
|
--from-literal=aws-access-key-id=<your-access-key-id> \
|
||||||
--from-literal=aws-secret-access-key=<your-secret-access-key> \
|
--from-literal=aws-secret-access-key=<your-secret-access-key> \
|
||||||
@@ -49,7 +49,7 @@ kubectl create secret generic aws-secret -n irsa-manager-system \
|
|||||||
|
|
||||||
Define and apply an IRSASetup custom resource according to your needs.
|
Define and apply an IRSASetup custom resource according to your needs.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
apiVersion: irsa.kkb0318.github.io/v1alpha1
|
apiVersion: irsa.kkb0318.github.io/v1alpha1
|
||||||
kind: IRSASetup
|
kind: IRSASetup
|
||||||
metadata:
|
metadata:
|
||||||
@@ -68,7 +68,7 @@ spec:
|
|||||||
|
|
||||||
Execute the following commands on the control plane server to save the public and private keys for Kubernetes signatures:
|
Execute the following commands on the control plane server to save the public and private keys for Kubernetes signatures:
|
||||||
|
|
||||||
```
|
```console
|
||||||
kubectl get secret -n kube-system irsa-manager-key -o jsonpath="{.data.ssh-privatekey}" | base64 --decode | sudo tee /etc/kubernetes/pki/irsa-manager.key > /dev/null
|
kubectl get secret -n kube-system irsa-manager-key -o jsonpath="{.data.ssh-privatekey}" | base64 --decode | sudo tee /etc/kubernetes/pki/irsa-manager.key > /dev/null
|
||||||
kubectl get secret -n kube-system irsa-manager-key -o jsonpath="{.data.ssh-publickey}" | base64 --decode | sudo tee /etc/kubernetes/pki/irsa-manager.pub > /dev/null
|
kubectl get secret -n kube-system irsa-manager-key -o jsonpath="{.data.ssh-publickey}" | base64 --decode | sudo tee /etc/kubernetes/pki/irsa-manager.pub > /dev/null
|
||||||
```
|
```
|
||||||
@@ -121,7 +121,7 @@ You can set IRSA for the Kubernetes ServiceAccount.
|
|||||||
|
|
||||||
The following example shows that irsa-manager sets the `irsa1-sa` ServiceAccount in the kube-system and default namespaces with the AmazonS3FullAccess policy:
|
The following example shows that irsa-manager sets the `irsa1-sa` ServiceAccount in the kube-system and default namespaces with the AmazonS3FullAccess policy:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
apiVersion: irsa.kkb0318.github.io/v1alpha1
|
apiVersion: irsa.kkb0318.github.io/v1alpha1
|
||||||
kind: IRSA
|
kind: IRSA
|
||||||
metadata:
|
metadata:
|
||||||
@@ -147,7 +147,7 @@ For more details, please see the API Reference.
|
|||||||
To verify the above example and ensure the IRSA works correctly, you can check the following job.
|
To verify the above example and ensure the IRSA works correctly, you can check the following job.
|
||||||
There is a Kubernetes job that will put one file into the S3 bucket, confirming that the Pod can assume the role to get S3 write permission:
|
There is a Kubernetes job that will put one file into the S3 bucket, confirming that the Pod can assume the role to get S3 write permission:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
cd validation
|
cd validation
|
||||||
sh s3-echoer.sh
|
sh s3-echoer.sh
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,8 +1,31 @@
|
|||||||
# irsa-manager
|
# irsa-manager
|
||||||
|
|
||||||
  
|
[irsa-manager](https://github.com/kkb0318/irsa-manager) IRSA manager allows you to easily set up IAM Roles for Service Accounts (IRSA) on non-EKS Kubernetes clusters.
|
||||||
|
|
||||||
A Helm chart for Kubernetes
|
## Setup
|
||||||
|
|
||||||
|
* Get Repo Info
|
||||||
|
```console
|
||||||
|
helm repo add kkb0318 https://kkb0318.github.io/irsa-manager
|
||||||
|
helm repo update
|
||||||
|
```
|
||||||
|
|
||||||
|
* Install Chart
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install irsa-manager kkb0318/irsa-manager -n irsa-manager-system --create-namespace
|
||||||
|
```
|
||||||
|
|
||||||
|
* Set AWS Secret for IRSA Manager
|
||||||
|
|
||||||
|
```console
|
||||||
|
kubectl create secret generic aws-secret -n irsa-manager-system \
|
||||||
|
--from-literal=aws-access-key-id=<your-access-key-id> \
|
||||||
|
--from-literal=aws-secret-access-key=<your-secret-access-key> \
|
||||||
|
--from-literal=aws-region=<your-region> \
|
||||||
|
--from-literal=aws-role-arn=<your-role-arn> # Optional: Set this if you want to switch roles
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
{{ template "chart.header" . }}
|
||||||
|
|
||||||
|
[irsa-manager](https://github.com/kkb0318/irsa-manager) IRSA manager allows you to easily set up IAM Roles for Service Accounts (IRSA) on non-EKS Kubernetes clusters.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
* Get Repo Info
|
||||||
|
```console
|
||||||
|
helm repo add kkb0318 https://kkb0318.github.io/irsa-manager
|
||||||
|
helm repo update
|
||||||
|
```
|
||||||
|
|
||||||
|
* Install Chart
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install irsa-manager kkb0318/irsa-manager -n irsa-manager-system --create-namespace
|
||||||
|
```
|
||||||
|
|
||||||
|
* Set AWS Secret for IRSA Manager
|
||||||
|
|
||||||
|
```console
|
||||||
|
kubectl create secret generic aws-secret -n irsa-manager-system \
|
||||||
|
--from-literal=aws-access-key-id=<your-access-key-id> \
|
||||||
|
--from-literal=aws-secret-access-key=<your-secret-access-key> \
|
||||||
|
--from-literal=aws-region=<your-region> \
|
||||||
|
--from-literal=aws-role-arn=<your-role-arn> # Optional: Set this if you want to switch roles
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
{{ template "chart.valuesSection" . }}
|
||||||
|
|
||||||
Reference in New Issue
Block a user