github.com/weaveworks/profiles
Gitops native package management.
The dependency libgit2 v1.1.0 needs to be installed to be able to run the Controller or its test-suite locally. Docs on install libgit2
buf is needed to generate and lint protoc code. For more details check out Generating the protocol files.
Set up local environment: make local-env.
This will start a local kind cluster and installs
the profiles and flux components.
Deploy an example catalog source kubectl apply -f examples/profile-catalog-source.yaml
All tests can be run with make test.
Acceptance tests can be run with make acceptance.
For further commands, run make help.
There are some manual steps right now, should be streamlined soon.
Steps:
Create a new release notes file:
touch docs/release_notes/<version>.md
Copy-and paste the release notes from the draft on the releases page into this file.
Note: sometimes the release drafter is a bit of a pain, verify that the notes are
correct by doing something like: git log --first-parent tag1..tag2.
PR the release notes into main.
Create and push a tag with the new version:
git tag <version>
git push origin <version>
The Create release action should run. Verify that:
As part of pushing a new branch to profiles, a new dev tag will be created for that branch. This action is part of
the procedure around working with profiles and pctl, its companion CLI tool. The details of this are
explained in pctl's README section Working with Profiles.
The dev tag's format is as follows: <currentLatestReleaseTag>-<branch-name>.
profiles is using buf to generate and lint protobuf implementations. The protocol descriptor file
can be found here profiles.proto. To update these files, install buf and run the make target
make generate-protoc. Profiles, using the tools way to track dependencies,
and should already have all the necessary protoc tools installed.
When running buf for the first time, install all the necessary libraries by running buf beta mod update. This will install
dependencies defined in buf.yaml file.
What gets generated is defined by buf.gen.yaml file. For the document target to work, install protoc-gen-doc
by running go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc.
Documentation about the protoc files can be found under docs/index.html.
A Profile is a "package" of Kubernetes deployable objects, known as Artifacts, and configurable values. Artifacts are one of: Helm Chart; Helm Release; raw yaml; Kustomize patch; Profile (nested).
For an example, see the profiles-examples.
A Catalog is an in-memory cache of Profiles. There is one Catalog per running Profile Controller. The Catalog is queryable via pctl or the API directly which runs alongside the Profiles Controller.
Profiles can be added to the Catalog by creating a ProfileCatalogSource.
A ProfileCatalogSource is a custom resource through which approved Profiles can be managed in the Catalog
// ProfileCatalogSourceSpec defines the desired state of ProfileCatalogSource
type ProfileCatalogSourceSpec struct {
// Profiles is the list of profiles exposed by the catalog
Profiles []ProfileDescription `json:"profiles,omitempty"`
}
// ProfileDescription defines details about a given profile.
type ProfileDescription struct {
// Profile name
Name string `json:"name,omitempty"`
// Profile description
Description string `json:"description,omitempty"`
// Version
// +optional
Version string `json:"version,omitempty"`
// CatalogSource is the name of the catalog the profile is listed in
// +optional
CatalogSource string `json:"catalog,omitempty"`
// URL is the full URL path to the profile.yaml
// +optional
URL string `json:"url,omitempty"`
// Maintainer is the name of the author(s)
// +optional
Maintainer string `json:"maintainer,omitempty"`
// Prerequisites are a list of dependencies required by the profile
// +optional
Prerequisites []string `json:"prerequisites,omitempty"`
}
Profiles can therefore be grouped and namespaced within the Catalog.
The Profile Catalog Source Controller reconciles ProfileCatalogSource resources.
See architecture diagrams below for what the reconciliation process does.
Illustration of how Profiles are added to the Catalog and how they can then be queried via the Catalog API:
To see how a profile installation works, take a look at the pctl documentation
Install:
pctl in a gitops way (ie there is a PR involved, and nobody touches the cluster)Configure:
Update:
Catalog sources:
Catalog management:
API:
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.