Skip to content

Commit 56080ad

Browse files
katallaxiekatallaxie
authored
chore: setup controller
1 parent 3412af4 commit 56080ad

16 files changed

+2551
-305
lines changed

Diff for: ‎LICENSE

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

Diff for: ‎README.md

+2-111
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,5 @@
1-
# temp
2-
// TODO(user): Add simple overview of use/purpose
3-
4-
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
6-
7-
## Getting Started
8-
9-
### Prerequisites
10-
- go version v1.22.0+
11-
- docker version 17.03+.
12-
- kubectl version v1.11.3+.
13-
- Access to a Kubernetes v1.11.3+ cluster.
14-
15-
### To Deploy on the cluster
16-
**Build and push your image to the location specified by `IMG`:**
17-
18-
```sh
19-
make docker-build docker-push IMG=<some-registry>/temp:tag
20-
```
21-
22-
**NOTE:** This image ought to be published in the personal registry you specified.
23-
And it is required to have access to pull the image from the working environment.
24-
Make sure you have the proper permission to the registry if the above commands don’t work.
25-
26-
**Install the CRDs into the cluster:**
27-
28-
```sh
29-
make install
30-
```
31-
32-
**Deploy the Manager to the cluster with the image specified by `IMG`:**
33-
34-
```sh
35-
make deploy IMG=<some-registry>/temp:tag
36-
```
37-
38-
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
39-
privileges or be logged in as admin.
40-
41-
**Create instances of your solution**
42-
You can apply the samples (examples) from the config/sample:
43-
44-
```sh
45-
kubectl apply -k config/samples/
46-
```
47-
48-
>**NOTE**: Ensure that the samples has default values to test it out.
49-
50-
### To Uninstall
51-
**Delete the instances (CRs) from the cluster:**
52-
53-
```sh
54-
kubectl delete -k config/samples/
55-
```
56-
57-
**Delete the APIs(CRDs) from the cluster:**
58-
59-
```sh
60-
make uninstall
61-
```
62-
63-
**UnDeploy the controller from the cluster:**
64-
65-
```sh
66-
make undeploy
67-
```
68-
69-
## Project Distribution
70-
71-
Following are the steps to build the installer and distribute this project to users.
72-
73-
1. Build the installer for the image built and published in the registry:
74-
75-
```sh
76-
make build-installer IMG=<some-registry>/temp:tag
77-
```
78-
79-
NOTE: The makefile target mentioned above generates an 'install.yaml'
80-
file in the dist directory. This file contains all the resources built
81-
with Kustomize, which are necessary to install this project without
82-
its dependencies.
83-
84-
2. Using the installer
85-
86-
Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
87-
88-
```sh
89-
kubectl apply -f https://raw.githubusercontent.com/<org>/temp/<tag or branch>/dist/install.yaml
90-
```
91-
92-
## Contributing
93-
// TODO(user): Add detailed information on how you would like others to contribute to this project
94-
95-
**NOTE:** Run `make help` for more information on all potential `make` targets
96-
97-
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
1+
# OpenFGA Operator
982

993
## License
1004

101-
Copyright 2024.
102-
103-
Licensed under the Apache License, Version 2.0 (the "License");
104-
you may not use this file except in compliance with the License.
105-
You may obtain a copy of the License at
106-
107-
http://www.apache.org/licenses/LICENSE-2.0
108-
109-
Unless required by applicable law or agreed to in writing, software
110-
distributed under the License is distributed on an "AS IS" BASIS,
111-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
112-
See the License for the specific language governing permissions and
113-
limitations under the License.
114-
5+
[Apache 2.0](/LICENSE)

Diff for: ‎api/gen.go

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//go:build generate
2+
// +build generate
3+
4+
//go:generate rm -rf ../manifests/crd/bases
5+
//go:generate go run -tags generate sigs.k8s.io/controller-tools/cmd/[email protected] object:headerFile="../hack/copyright.go.txt" paths="./..."
6+
//go:generate go run -tags generate sigs.k8s.io/controller-tools/cmd/[email protected] rbac:roleName=manager-role crd webhook output:crd:artifacts:config=../manifests/crd/bases paths="./..."
7+
8+
package api
9+
10+
import (
11+
_ "sigs.k8s.io/controller-tools/cmd/controller-gen" //nolint:typecheck
12+
)

Diff for: ‎api/v1alpha1/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// +k8s:deepcopy-gen=package
2+
package v1alpha1

Diff for: ‎api/v1alpha1/groupversion_info.go

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Package v1alpha1 contains API Schema definitions for the nats v1alpha1 API group
2+
// +kubebuilder:object:generate=true
3+
// +groupName=openfga.zeiss.com
4+
5+
package v1alpha1
6+
7+
import (
8+
"k8s.io/apimachinery/pkg/runtime/schema"
9+
"sigs.k8s.io/controller-runtime/pkg/scheme"
10+
)
11+
12+
var (
13+
// GroupVersion is group version used to register these objects
14+
GroupVersion = schema.GroupVersion{Group: "openfga.zeiss.com", Version: "v1alpha1"}
15+
16+
// SchemeBuilder is used to add go types to the GroupVersionKind scheme
17+
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
18+
19+
// AddToScheme adds the types in this group-version to the given scheme.
20+
AddToScheme = SchemeBuilder.AddToScheme
21+
)

Diff for: ‎api/v1alpha1/openfga_store_types.go

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package v1alpha1
2+
3+
import (
4+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
5+
)
6+
7+
type OpenFGAStoreSpec struct{}
8+
9+
type OpenFGAStoreStatus struct {
10+
StoreID string `json:"storeID"`
11+
}
12+
13+
//+kubebuilder:object:root=true
14+
//+kubebuilder:subresource:status
15+
16+
type OpenFGAStore struct {
17+
metav1.TypeMeta `json:",inline"`
18+
metav1.ObjectMeta `json:"metadata,omitempty"`
19+
20+
Spec OpenFGAStoreSpec `json:"spec,omitempty"`
21+
Status OpenFGAStoreStatus `json:"status,omitempty"`
22+
}
23+
24+
//+kubebuilder:object:root=true
25+
26+
// OpenFGAStoreList contains a list of NatsOperator
27+
type OpenFGAStoreList struct {
28+
metav1.TypeMeta `json:",inline"`
29+
metav1.ListMeta `json:"metadata,omitempty"`
30+
Items []OpenFGAStore `json:"items"`
31+
}
32+
33+
func init() {
34+
SchemeBuilder.Register(&OpenFGAStore{}, &OpenFGAStoreList{})
35+
}

0 commit comments

Comments
 (0)