kubernetes-nmstate

0.82.0 Opens a new window with list of versions in this module.

Declarative node network configuration driven through Kubernetes API. For more information about how to use this package see README

Latest version published 1 month ago

GitHub

Package Health Score

67 / 100

security
Security issues found
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

Imported By: 0
GitHub Stars: 162
Forks: 81
Contributors: 40

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package kubernetes-nmstate, we found that it has been 162 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

Security issues found

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Apr 17, 2024

License

GPL-2.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like kubernetes-nmstate is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 18
Open PR: 4
Last Release: 1 month ago
Last Commit: 3 months ago

Further analysis of the maintenance status of github.com/nmstate/kubernetes-nmstate based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that github.com/nmstate/kubernetes-nmstate demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the github.com/nmstate/kubernetes-nmstate repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/nmstate/kubernetes-nmstate is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

kubernetes-nmstate

[keɪ ɛn ɛm steɪt] Declarative node network configuration driven through Kubernetes API.

How it works

We use nmstate to perform state driven network configuration on cluster nodes and to report back their current state. Both the configuration and reporting is controlled via Kubernetes objects.

apiVersion: nmstate.io/v1
kind: NodeNetworkConfigurationPolicy
metadata:
  name: br1-eth0
spec:
  desiredState:
    interfaces:
    - name: br1
      type: linux-bridge
      state: up
      ipv4:
        dhcp: true
        enabled: true
      bridge:
        port:
        - name: eth0

The only external dependency is NetworkManager running on nodes. See more details in Compatibility documentation.

Deployment and Usage

You can choose to deploy this operator on a local virtualized cluster or on your arbitrary cluster.

Following comprehensive 101 series is the best place to start learning about all the features:

Reporting - observe the current state of network on cluster nodes.
Configuring - configure networks and observe the progress.
Troubleshooting - see what's wrong if a configuration fails.

These example manifests should serve as reference on how to configure various configuration options:

The "Why"

With hybrid clouds, node-networking setup is becoming even more challenging. Different payloads have different networking requirements, and not everything can be satisfied as overlays on top of the main interface of the node (e.g. SR-IOV, L2, other L2). The Container Network Interface (CNI) standard enables different solutions for connecting networks on the node with pods. Some of them are part of the standard, and there are others that extend support for Open vSwitch bridges, SR-IOV, and more...

However, in all of these cases, the node must have the networks setup before the pod is scheduled. Setting up the networks in a dynamic and heterogenous cluster, with dynamic networking requirements, is a challenge by itself - and this is what this project is addressing.

Development and Contributing

Contributions are welcome! Find details about the project's design and development workflow in the developer guide.

FAQs

What is kubernetes-nmstate?

Declarative node network configuration driven through Kubernetes API. Visit Snyk Advisor to see a full health score report for kubernetes-nmstate, including popularity, security, maintenance & community analysis.

Is kubernetes-nmstate popular?

The golang package kubernetes-nmstate receives a total of ? weekly downloads. As such, kubernetes-nmstate popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is kubernetes-nmstate well maintained?

We found that kubernetes-nmstate demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is kubernetes-nmstate safe to use?

Security issues were found while scanning the latest version of kubernetes-nmstate, and a total of 0 vulnerabilities were detected. It is highly advised to conduct a security review before using this package. View the full security scan results.

Last updated on 20 May-2024, at 23:02 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Usage Popularity

Security risks

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

kubernetes-nmstate

How it works

Deployment and Usage

The "Why"

Development and Contributing

FAQs

What is kubernetes-nmstate?

Is kubernetes-nmstate popular?

Is kubernetes-nmstate well maintained?

Is kubernetes-nmstate safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues