Skip to content

Commit 07709c3

Browse files
syscod3claude
syscod3
and
claude
committed
chore: repo bootstrap — license, gitignore, mise, agents
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 23d69de commit 07709c3

4 files changed

Lines changed: 252 additions & 1 deletion

File tree

‎.gitignore‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,18 @@ go.work
2828

2929
# Kubeconfig might contain secrets
3030
*.kubeconfig
31+
32+
# OS
33+
.DS_Store
34+
Thumbs.db
35+
36+
# Build artifacts
37+
dist/
38+
release/
39+
40+
# Local overrides
41+
*.local.yaml
42+
*.local.json
43+
44+
# Claude
45+
.claude/

‎AGENTS.md‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,60 @@
1-
# oci-pivot-controller - AI Agent Guide
1+
# oci-pivot-controller — Agent Guide
2+
3+
## What this is
4+
5+
A Kubernetes controller that provides MetalLB-style floating public IPs on OCI — without MetalLB.
6+
OCI blocks gratuitous ARP (no L2 mode) and has no BGP peering, so this controller uses OCI's native
7+
secondary private IP + reserved public IP API to route traffic to the right node, then relies on
8+
`Service.spec.externalIPs` + Cilium for node→pod DNAT.
9+
10+
## Architecture
11+
12+
- `api/v1alpha1/pivotip_types.go` — `PivotIP` CRD: serviceRef, nodeSelector, compartmentId
13+
- `internal/oci/client.go` — OCI API wrapper (instance principal auth, VNIC + IP lifecycle)
14+
- `internal/controller/pivotip_controller.go` — reconciler: balance-elect node, create/reassign OCI IPs, patch Service externalIPs, finalizer cleanup
15+
- Node watcher triggers re-election when a node goes NotReady
16+
17+
## Essential commands
18+
19+
```bash
20+
make generate # regenerate zz_generated.deepcopy.go after types change
21+
make manifests # regenerate CRDs + RBAC after marker changes — COMMIT THE RESULT
22+
make test # unit + envtest
23+
make lint # golangci-lint (custom binary with logcheck plugin)
24+
make build # build binary
25+
```
26+
27+
## After changing api/v1alpha1/pivotip_types.go
28+
29+
Always run in this order:
30+
1. `make generate`
31+
2. `make manifests`
32+
3. `make test`
33+
4. Commit all three outputs together
34+
35+
## Coding conventions
36+
37+
- **Logging**: K8s structured style — capital first word, no period, past tense for events
38+
- `log.Info("secondary private IP created", "ocid", ocid, "ip", addr)` ✓
39+
- `log.Info("creating secondary private IP...")` ✗
40+
- **RBAC markers**: on the `Reconcile()` function, not `SetupWithManager()`
41+
- **Reconciler**: always idempotent — check `pip.Status.*OCID` before calling OCI API
42+
- **Finalizer**: `pivot.oci.io/finalizer` — added on first reconcile, removed only after OCI cleanup
43+
- **OCI errors**: wrap with `fmt.Errorf("context: %w", err)`, never swallow
44+
45+
## OCI instance principal auth
46+
47+
The controller authenticates as the OCI node instance — no API key or Secret needed.
48+
Requires an IAM dynamic group + policy (see `docs/iam-policy.md` once created).
49+
Local dev: set `OCI_CONFIG_FILE` + `OCI_PROFILE` env vars to use a file-based provider instead.
50+
51+
## Troubleshooting
52+
53+
- **`instance principal provider` error locally**: running outside OCI — use `OCI_CONFIG_FILE` env var
54+
- **Node has no providerID**: OCI CCM not installed, or node not yet registered — check `kubectl get node -o yaml`
55+
- **409 Conflict on public IP creation**: IP already exists in OCI but not in status — check OCI console, import OCID into status manually or delete in OCI
56+
57+
---
258

359
## Project Structure
460

‎LICENSE‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
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 made available under
36+
the License, as indicated by a copyright notice that is included in
37+
or attached to the work (an example is provided in the Appendix below).
38+
39+
"Derivative Works" shall mean any work, whether in Source or Object
40+
form, that is based on (or derived from) the Work and for which the
41+
editorial revisions, annotations, elaborations, or other modifications
42+
represent, as a whole, an original work of authorship. For the purposes
43+
of this License, Derivative Works shall not include works that remain
44+
separable from, or merely link (or bind by name) to the interfaces of,
45+
the Work and Derivative Works thereof.
46+
47+
"Contribution" shall mean, as submitted to the Licensor for inclusion
48+
in the Work by the copyright owner or by an individual or Legal Entity
49+
authorized to submit on behalf of the copyright owner. For the purposes
50+
of this definition, "submission" includes any form of electronic, verbal,
51+
or written communication sent to the Licensor or its representatives,
52+
including but not limited to communication on electronic mailing lists,
53+
source code control systems, and issue tracking systems that are managed
54+
by, or on behalf of, the Licensor for the purpose of developing and
55+
improving the Work, but excluding communication that is conspicuously
56+
marked or designated in writing by the copyright owner as "Not a
57+
Contribution."
58+
59+
"Contributor" shall mean Licensor and any Legal Entity on behalf of
60+
whom a Contribution has been received by the Licensor and included
61+
within the Work.
62+
63+
2. Grant of Copyright License. Subject to the terms and conditions of
64+
this License, each Contributor hereby grants to You a perpetual,
65+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66+
copyright license to reproduce, prepare Derivative Works of,
67+
publicly display, publicly perform, sublicense, and distribute the
68+
Work and such Derivative Works in Source or Object form.
69+
70+
3. Grant of Patent License. Subject to the terms and conditions of
71+
this License, each Contributor hereby grants to You a perpetual,
72+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
73+
(except as stated in this section) patent license to make, have made,
74+
use, offer to sell, sell, import, and otherwise transfer the Work,
75+
where such license applies only to those patent claims licensable
76+
by such Contributor that are necessarily infringed by their
77+
Contribution(s) alone or by the combination of their Contribution(s)
78+
with the Work to which such Contribution(s) was submitted. If You
79+
institute patent litigation against any entity (including a cross-claim
80+
or counterclaim in a lawsuit) alleging that the Work or any patent
81+
claims embodied in the Work constitute direct or indirect patent
82+
infringement, then any patent licenses granted to You under this
83+
License for that Work shall terminate as of the date such litigation
84+
is filed.
85+
86+
4. Redistribution. You may reproduce and distribute copies of the
87+
Work or Derivative Works thereof in any medium, with or without
88+
modifications, and in Source or Object form, provided that You
89+
meet the following conditions:
90+
91+
(a) You must give any other recipients of the Work or Derivative
92+
Works a copy of this License; and
93+
94+
(b) You must cause any modified files to carry prominent notices
95+
stating that You changed the files; and
96+
97+
(c) You must retain, in the Source form of any Derivative Works
98+
that You distribute, all copyright, patent, trademark, and
99+
attribution notices from the Source form of the Work,
100+
excluding those notices that do not pertain to any part of
101+
the Derivative Works; and
102+
103+
(d) If the Work includes a "NOTICE" text file as part of its
104+
distribution, You must include a readable copy of the
105+
attribution notices contained within such NOTICE file, in
106+
at least one of the following places: within a NOTICE text
107+
file distributed as part of the Derivative Works; within
108+
the Source form or documentation, if provided along with the
109+
Derivative Works; or, within a display generated by the
110+
Derivative Works, if and wherever such third-party notices
111+
normally appear. The contents of the NOTICE file are for
112+
informational purposes only and do not modify the License.
113+
You may add Your own attribution notices within Derivative
114+
Works that You distribute, alongside or in addition to the
115+
NOTICE text from the Work, provided that such additional
116+
attribution notices cannot be construed as modifying the License.
117+
118+
You may add Your own license statement for Your modifications and
119+
may provide additional grant of rights to use, copy, modify, merge,
120+
publish, distribute, sublicense, and/or sell copies of the
121+
Contribution, either on an unmodified basis, with modifications, or
122+
as part of a larger work.
123+
124+
5. Submission of Contributions. Unless You explicitly state otherwise,
125+
any Contribution intentionally submitted for inclusion in the Work
126+
by You to the Licensor shall be under the terms and conditions of
127+
this License, without any additional terms or conditions.
128+
Notwithstanding the above, nothing herein shall supersede or modify
129+
the terms of any separate license agreement you may have executed
130+
with Licensor regarding such Contributions.
131+
132+
6. Trademarks. This License does not grant permission to use the trade
133+
names, trademarks, service marks, or product names of the Licensor,
134+
except as required for reasonable and customary use in describing the
135+
origin of the Work and reproducing the content of the NOTICE file.
136+
137+
7. Disclaimer of Warranty. Unless required by applicable law or
138+
agreed to in writing, Licensor provides the Work (and each
139+
Contributor provides its Contributions) on an "AS IS" BASIS,
140+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
141+
implied, including, without limitation, any conditions of title,
142+
merchantability, or fitness for a particular purpose. You are solely
143+
responsible for determining the appropriateness of using or
144+
redistributing the Work and assume any risks associated with Your
145+
exercise of permissions under this License.
146+
147+
8. Limitation of Liability. In no event and under no legal theory,
148+
whether in tort (including negligence), contract, or otherwise,
149+
unless required by applicable law (such as deliberate and grossly
150+
negligent acts) or agreed to in writing, shall any Contributor be
151+
liable to You for damages, including any direct, indirect, special,
152+
incidental, or exemplary damages of any character arising as a
153+
result of this License or out of the use or inability to use the
154+
Work (even if such Contributor has been advised of the possibility
155+
of such damages).
156+
157+
9. Accepting Warranty or Additional Liability. While redistributing
158+
the Work or Derivative Works thereof, You may choose to offer,
159+
and charge a fee for, acceptance of support, warranty, indemnity,
160+
or other liability obligations and/or rights consistent with this
161+
License. However, in accepting such obligations, You may offer only
162+
conditions that are fully consistent with this License.
163+
164+
END OF TERMS AND CONDITIONS
165+
166+
Copyright 2026 syscode-labs
167+
168+
Licensed under the Apache License, Version 2.0 (the "License");
169+
you may not use this file except in compliance with the License.
170+
You may obtain a copy of the License at
171+
172+
http://www.apache.org/licenses/LICENSE-2.0
173+
174+
Unless required by applicable law or agreed to in writing, software
175+
distributed under the License is distributed on an "AS IS" BASIS,
176+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
177+
See the License for the specific language governing permissions and
178+
limitations under the License.

‎mise.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[tools]
2+
kind = "0.20.0"

0 commit comments

Comments
 (0)