Skip to content

Commit 869afe0

Browse files
committed
Restructure repository and trigger fixes.
1 parent 1da7e61 commit 869afe0

File tree

6 files changed

+19
-55
lines changed

6 files changed

+19
-55
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,29 @@ Reflector is a Kubernetes addon designed to monitor changes to resources (secret
66
[![Docker Image](https://img.shields.io/docker/image-size/emberstack/kubernetes-reflector/latest?style=flat-square)](https://hub.docker.com/r/emberstack/kubernetes-reflector)
77
[![Docker Pulls](https://img.shields.io/docker/pulls/emberstack/kubernetes-reflector?style=flat-square)](https://hub.docker.com/r/emberstack/kubernetes-reflector)
88
[![license](https://img.shields.io/github/license/emberstack/kubernetes-reflector.svg?style=flat-square)](LICENSE)
9+
[![slack](https://img.shields.io/badge/join-emberstack%20on%20Slack-gray.svg?style=flat-square&longCache=true&logo=slack&colorB=green)](https://join.slack.com/t/emberstack/shared_invite/zt-8qyutopg-9ghwTq3OnHSm2tY9Sk5ULA)
910

1011

1112
> Supports `amd64`, `arm`
1213
1314
### Extensions
1415
Reflector includes a cert-manager extension used to automatically annotate created secrets and allow reflection. See the `cert-manager` extension usage below for more details.
1516

17+
18+
## Support
19+
If you need help or found a bug, please feel free to open an Issue on GitHub (https://github.com/emberstack/kubernetes-reflector/issues).
20+
21+
You can also join our Slack workspace and talk to us:
22+
[![slack](https://img.shields.io/badge/join-emberstack%20on%20Slack-gray.svg?style=flat-square&longCache=true&logo=slack&colorB=green)](https://join.slack.com/t/emberstack/shared_invite/zt-8qyutopg-9ghwTq3OnHSm2tY9Sk5ULA)
23+
24+
1625
## Deployment
1726

1827
Reflector can be deployed either manually or using Helm (recommended).
1928

29+
### Prerequisites
30+
- Kubernetes 1.14+
31+
2032
#### Deployment using Helm
2133

2234
Use Helm to install the latest released chart:
@@ -142,7 +154,7 @@ $ kubectl apply -f https://github.com/emberstack/kubernetes-reflector/releases/l
142154

143155
## (Optional) `cert-manager` extension
144156

145-
> The current release supports `cert-manager` from version `0.11.0` or higher. If you're using an older version, please use Reflector version `v2.19193.2`
157+
> Supported `cert-manager` version: `0.11.0` or higher.
146158

147159
Reflector can automatically annotate secrets created by cert-manager by annotating the `Certificate` object. This allows for issued certificates (example: wildcard certificates) to be reused in other namespaces and permit automatic updates of mirrors on certificate renewal.
148160

@@ -154,7 +166,7 @@ Reflector can automatically annotate secrets created by cert-manager by annotati
154166

155167
In the following example, the generated secret `certificate-secret` will be annotated with the `reflector.v1.k8s.emberstack.com/reflection-allowed` and `reflector.v1.k8s.emberstack.com/reflection-allowed-namespaces` based on the certificate annotations.
156168
```yaml
157-
apiVersion: certmanager.k8s.io/v1alpha1
169+
apiVersion: cert-manager.io/v1alpha1
158170
kind: Certificate
159171
metadata:
160172
name: some-certificate

azure-pipelines.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ trigger:
1313
paths:
1414
include:
1515
- src/*
16+
- azure-pipelines.yaml
1617

1718
stages:
1819

@@ -36,6 +37,10 @@ stages:
3637
inputs:
3738
helmVersionToInstall: '3.1.1'
3839

40+
- script: |
41+
cp README.md src/helm/reflector/README.md
42+
displayName: 'import README'
43+
3944
- script: |
4045
helm package --destination $(Build.ArtifactStagingDirectory)/artifacts/helm --version $(Build.BuildNumber) --app-version $(Build.BuildNumber) src/helm/reflector
4146
displayName: 'helm package'
File renamed without changes.
File renamed without changes.

src/helm/reflector/README.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

0 commit comments

Comments
 (0)