Skip to content

Commit 28ab03f

Browse files
authored
Merge pull request #4 from edenlabllc/release/v0.1.0
Release/v0.1.0
2 parents 0aa493d + 1ecb64e commit 28ab03f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+4600
-1
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Prepare tenant Artifact with auto-tagging
2+
3+
on:
4+
push:
5+
branches:
6+
- staging
7+
- production
8+
9+
jobs:
10+
tenant-artifact:
11+
name: Checkout main repositories, create and upload tenant Artifact
12+
runs-on: ubuntu-22.04
13+
steps:
14+
- name: Checkout main repository
15+
uses: actions/checkout@v4
16+
with:
17+
ref: ${{ github.ref }}
18+
fetch-depth: 0
19+
20+
- name: Create and upload tenant Artifact
21+
uses: edenlabllc/tenant-artifact.ci.action@v1
22+
with:
23+
autotag: true
24+
github_token_repo_full_access: ${{ secrets.GH_TOKEN_REPO_FULL_ACCESS }}
25+
skip_release_artifact: true
26+
slack_notifications: true
27+
slack_webhook: ${{ secrets.SLACK_WEBHOOK_RELEASES }}
28+
slack_message_release_notes_path: docs/release-notes.md

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**.dec
2+
*/cluster/k3d/
3+
dist/
4+
.DS_Store
5+
.PROJECT/
6+
.deps/
7+
.env
8+
.helmfile/
9+
.idea/
10+
sops-age-keys/

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

README.md

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,86 @@
11
# cluster-deps.bootstrap.infra
2-
Cluster deps infrastructure
2+
3+
[![Release](https://img.shields.io/github/v/release/edenlabllc/cluster-deps.bootstrap.infra.svg?style=for-the-badge)](https://github.com/edenlabllc/cluster-deps.bootstrap.infra/releases/latest)
4+
[![Software License](https://img.shields.io/github/license/edenlabllc/cluster-deps.bootstrap.infra.svg?style=for-the-badge)](LICENSE)
5+
[![Powered By: Edenlab](https://img.shields.io/badge/powered%20by-edenlab-8A2BE2.svg?style=for-the-badge)](https://edenlab.io)
6+
7+
## Description
8+
9+
This repository provides a general set of [Cluster API](https://cluster-api.sigs.k8s.io) and system components
10+
required for provisioning of Kubernetes clusters for different providers.
11+
It is inherited by other tenant repositories.
12+
Mainly, it is designed to be managed by administrators, DevOps engineers, SREs.
13+
14+
## Getting Started
15+
16+
To get started with cluster-deps.bootstrap.infra, ensure you have all the necessary tools and dependencies installed.
17+
Detailed information about requirements and installation instructions can be found in the [Requirements](#requirements) section.
18+
19+
### Requirements
20+
21+
- Git
22+
- Note: K3D v5.x.x requires at least Docker v20.10.5 (runc >= v1.0.0-rc93) to work properly
23+
- [RMK CLI](https://edenlabllc.github.io/rmk/latest)
24+
25+
### GitLab flow strategy
26+
27+
This repository uses the Environment branches with GitLab flow approach,
28+
where each stable or ephemeral branches is a separate environment with its own Kubernetes cluster.
29+
30+
Release schema:
31+
```text
32+
develop ------> staging ------> production
33+
\ / \ /
34+
release/vN.N.N-rc release/vN.N.N
35+
```
36+
37+
### Generating project structure
38+
39+
> Note: The generated project structure using the RMK tools is mandatory and is required for the interaction of the RMK with the code base.
40+
> All generated files have example content and can be supplemented according to project requirements.
41+
42+
This example shows how the following options are configured and interact with each other:
43+
44+
- etc/deps/\<environment>/secrets/.spec.yaml.gotmpl
45+
- etc/deps/\<environment>/values/*.yaml.gotmpl
46+
- etc/deps/\<environment>/globals.yaml.gotmpl
47+
- etc/deps/\<environment>/releases.yaml
48+
- .gitignore
49+
- helmfile.yaml.gotmpl
50+
- project.yaml
51+
52+
53+
#### Available scopes of variables
54+
55+
- **deps**
56+
57+
### Basic RMK commands for project management
58+
59+
#### Project generate
60+
61+
```shell
62+
rmk project generate \
63+
--environment=develop.root-domain=localhost \
64+
--owners=user \
65+
--scopes=deps
66+
```
67+
68+
#### Initialization configuration
69+
70+
```shell
71+
rmk config init
72+
```
73+
74+
#### Create CAPI cluster
75+
76+
```shell
77+
rmk cluster capi create
78+
```
79+
80+
#### Release sync
81+
82+
```shell
83+
rmk release sync
84+
```
85+
86+
> Note: A complete list of RMK commands and capabilities can be found at the [link](https://edenlabllc.github.io/rmk/latest)

docs/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These owners will be the default owners for everything in
2+
# the repo and will be requested for review when someone opens a pull request.
3+
* @anovikov-el @apanasiuk-el

docs/release-notes.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Deps Release Notes
2+
3+
## Release v0.1.0
4+
5+
## What's new
6+
- Prepared repository for OSS.
7+
- Added project structure files.
8+
9+
## Bug fixes
10+
11+
## Additional information
12+
13+
### Mandatory updates for `project.yaml`
14+
15+
### List of updated releases
16+
17+
### List of added releases
18+
```yaml
19+
- name: capi-cluster
20+
chart: core-charts/k3d-cluster
21+
version: 0.1.0
22+
- name: clusterctl-config
23+
chart: core-charts/clusterctl-config
24+
version: 0.1.2
25+
- name: k3d-cluster
26+
chart: core-charts/k3d-cluster
27+
version: 0.1.0
28+
- name: aws-iam-controller
29+
chart: core-charts/iam-chart
30+
version: 1.3.13
31+
- name: aws-iam-provision-operator
32+
chart: core-charts/app
33+
version: 1.6.0
34+
- name: aws-iam-config
35+
chart: core-charts/aws-iam-config
36+
version: 0.1.0
37+
- name: aws-cluster
38+
chart: core-charts/aws-cluster
39+
version: 0.2.1
40+
- name: aws-iam-provision
41+
chart: core-charts/aws-iam-provision
42+
version: 0.1.0
43+
- name: azure-cluster
44+
chart: core-charts/azure-cluster
45+
version: 0.2.3
46+
- name: gcp-cluster
47+
chart: core-charts/gcp-cluster
48+
version: 0.2.1
49+
```

0 commit comments

Comments
 (0)