Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metacontroller for kubeflow 1.4 #1

Merged
merged 27 commits into from
Nov 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
af71a81
Initial commit
ca-scribner Sep 22, 2021
17010e7
feat: Add remove hook
ca-scribner Sep 22, 2021
db1856a
feat: encapsulate resource-check logic for reuse
ca-scribner Sep 22, 2021
5e7d673
feat: add reconcile loop on update-status hook
ca-scribner Sep 22, 2021
74fa19a
fix: tests
ca-scribner Sep 22, 2021
795323a
fix: tests
ca-scribner Sep 22, 2021
4887fb4
fix: add setuptools and pip to charmcraft parts for building
ca-scribner Oct 27, 2021
75c974e
fix: add missing yaml resources
ca-scribner Oct 28, 2021
b9694a9
feat: Add LICENSE, minor fixes
ca-scribner Nov 15, 2021
838d579
Misc updates from peer review
ca-scribner Nov 15, 2021
aa0dcc3
Misc updates from peer review
ca-scribner Nov 16, 2021
92045d0
Remove noop container
ca-scribner Nov 16, 2021
8f27442
feat: Use lightkube instead of kubectl for creating objects
ca-scribner Nov 16, 2021
03838fa
feat: unit tests for rendering yaml and creating k8s objects
ca-scribner Nov 17, 2021
da5abfb
feat: add unit tests for install and update_status events
ca-scribner Nov 17, 2021
af06c84
feat: refactor check_deployed_resources, add tests
ca-scribner Nov 18, 2021
4d1a478
fix: flake8 max-complexity, linting problems
ca-scribner Nov 18, 2021
74f44d2
feat: add StatefulSet validation and tests
ca-scribner Nov 18, 2021
6e38a7c
feat: add error message for when charm does not have trust
ca-scribner Nov 18, 2021
64bebb6
fix: typo in integrate.yaml
ca-scribner Nov 18, 2021
bfe2da4
fix: mock away lightkube client in unit tests
ca-scribner Nov 19, 2021
454e7a2
fix: update install process to handle resource conflicts
ca-scribner Nov 19, 2021
4200f8c
fix: formatting
ca-scribner Nov 19, 2021
85c3af5
fix: disable _no_trust integration test
ca-scribner Nov 19, 2021
24ef72b
Refactor to address review comments
ca-scribner Nov 19, 2021
198dd8c
Refactor to address review comments
ca-scribner Nov 23, 2021
29d8526
fix: test_check_deployed_resources
ca-scribner Nov 23, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions .github/workflows/integrate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: CI

on:
push:
branches:
- main
pull_request:
schedule:
- cron: '0 8 * * TUE'

jobs:
lint:
name: Lint
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
ca-scribner marked this conversation as resolved.
Show resolved Hide resolved
set -eux
sudo apt update
sudo apt install tox
- run: tox -vve lint

unit:
name: Unit Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: pip install tox
- run: tox -vve unit

integration:
name: Integration Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup operator environment
uses: charmed-kubernetes/actions-operator@main
with:
provider: microk8s
ca-scribner marked this conversation as resolved.
Show resolved Hide resolved
channel: 1.21/stable
charmcraft-channel: latest/candidate

- name: Test
run: sg microk8s -c "tox -vve integration -- --model testing"

# On failure, capture debugging resources
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO we can probably skip the comment, seeing if: failure() is easy to spot for me, at least

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one I actually like having. fwiw, I actually misread this the first time I saw it in charms. I see that comment as a header for the next 6 things, all of which happen in failures. Maybe it could be formatted differently instead?

- name: Get all
run: kubectl get all -A
if: failure()

- name: Describe deployments
run: kubectl describe deployments -A
if: failure()

- name: Describe replicasets
run: kubectl describe replicasets -A
if: failure()

- name: Get juju status
run: juju status
if: failure()

- name: Get application logs
run: kubectl logs -n testing --tail 1000 -lapp.kubernetes.io/name=metacontroller-operator
if: failure()

- name: Get application operator logs
run: kubectl logs -n testing --tail 1000 -loperator.juju.is/name=metacontroller-operator
if: failure()
45 changes: 45 additions & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Publish

on:
push:
branches:
- main

jobs:
charm:
name: Charm
runs-on: ubuntu-latest

steps:
- name: Check out code
uses: actions/checkout@v2

- name: Install dependencies
run: |
set -eux
sudo snap install charm --classic
sudo snap install charmcraft --classic --channel=latest-candidate
sudo snap install yq

# TODO: Publish to charmhub
# - name: Publish charm
# env:
# CHARMSTORE_CREDENTIAL: ${{ secrets.CHARMSTORE_CREDENTIAL }}
# run: |
# set -eux
# echo $CHARMSTORE_CREDENTIAL > ~/.go-cookies
#
# CS_URL="cs:~kubeflow-charmers/metacontroller-operator"
#
# # TODO: Make this loop over all resources
# IMAGE=$(yq eval '.resources.noop.upstream-source' metadata.yaml)
# charmcraft build
# docker pull $IMAGE
# charm push ./*.charm $CS_URL --resource oci-image=$IMAGE
#
# REVISION=$(charm show $CS_URL --channel unpublished --format yaml | yq e .id-revision.Revision -)
# OCI_VERSION=$(charm list-resources $CS_URL --format yaml --channel unpublished | yq e .0.revision -)
# charm release \
# --channel edge \
# --resource oci-image-$OCI_VERSION \
# $CS_URL-$REVISION
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
venv/
build/
.tox/
*.charm

.coverage
__pycache__/
*.py[cod]
3 changes: 3 additions & 0 deletions .jujuignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/venv
*.py[cod]
*.charm
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
14 changes: 14 additions & 0 deletions charmcraft.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: "charm"
bases:
- build-on:
- name: "ubuntu"
channel: "20.04"
run-on:
- name: "ubuntu"
channel: "20.04"
parts:
charm:
# Fixes jinja install during pack. See https://github.com/canonical/charmcraft/issues/551
charm-python-packages: [setuptools, pip]
# prime:
# - ./files/manifests/*.yaml
8 changes: 8 additions & 0 deletions metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: metacontroller-operator
display-name: Metacontroller-operator
description: |
Metacontroller is an add-on for Kubernetes to make it easier to write and deploy custom controllers,
reducing the need for boilerplate code.

https://github.com/metacontroller/metacontroller
summary: An add-on for Kubernetes to write and deploy custom controllers from simple scripts
6 changes: 6 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ops < 1.3.0
jinja2 < 3.1
oci-image < 1.1.0
kubernetes < 19.0.0
lightkube
tenacity < 9
Loading