Skip to content
Snippets Groups Projects
Commit a92cc441 authored by Riccardo Boero's avatar Riccardo Boero :innocent:
Browse files

Add License etc

parent 14e24bb3
No related branches found
No related tags found
No related merge requests found
image: julia:latest
stages:
- documentation
- deploy
# Documentation stage
build documentation:
stage: documentation
script:
- julia --project=. -e 'using Pkg; Pkg.instantiate()'
- julia --project=. docs/make.jl
artifacts:
paths:
- docs/build/
expire_in: 1 week
only:
- main
# Deploy stage for GitLab Pages
pages:
stage: deploy
script:
- mv docs/build public
artifacts:
paths:
- public
only:
- main
LICENSE 0 → 100644
This diff is collapsed.
# JuliaKubernetesClient
A Julia package designed to facilitate communication with Kubernetes clusters through their RESTful APIs. It provides a comprehensive set of tools to manage and automate cluster resources programmatically.
---
[![GitLab License](https://img.shields.io/gitlab/license/fact%2Futils%2FJuliaKubernetesClient.jl?gitlab_url=https%3A%2F%2Fgit.nilu.no&style=flat&color=orange)](https://www.gnu.org/licenses/agpl-3.0.en.html#license-text)
[![DOI](https://img.shields.io/badge/DOI-10.17605%2FOSF.IO%2FM3FBP-blue?style=flat)](https://doi.org/10.17605/OSF.IO/M3FBP)
---
## Use
1. To install the package in your project:
```julia
using Pkg
Pkg.add("https://git.nilu.no/fact/utils/JuliaKubernetesClient.jl.git")
```
2. To use the package:
```julia
using JuliaKubernetesClient
``````
Please refer to the package documentation for details on how to access Docker API: https://fact.pages.nilu.no/utils/JuliaKubernetesClient.jl/
---
## Specifications
The package supports key operations such as:
- Cluster Interaction: Test API connectivity, retrieve cluster information, and handle authentication.
- Pod Management: Create, list, delete pods, and execute commands within containers.
- Deployment and Scaling: Deploy applications, manage replicas, and scale resources dynamically.
- Service Management: Create, list, and delete Kubernetes Services for exposing workloads.
- ConfigMap and Secret Management: Handle ConfigMaps for configuration and Secrets for sensitive data.
- Namespace Management: Organize resources by creating, listing, and deleting namespaces.
- Logging and Monitoring: Fetch logs from pods and watch real-time events for diagnostics.
- Custom Resource Management: Apply YAML/JSON manifests to create or update resources, and delete resources by type and name.
---
## Notes
---
## Author
Riccardo Boero - ribo@nilu.no
## License
[![AGPL v3](https://www.gnu.org/graphics/agplv3-88x31.png "License Icon")](https://www.gnu.org/licenses/agpl-3.0.en.html#license-text)
## Citation
- Boero, Riccardo. 2024. “FACT Utils: Julia Kubernetes Client.” OSF. [doi:10.17605/OSF.IO/M3FBP](https://doi.org/10.17605/OSF.IO/M3FBP).
Part of the Fine scAle eConomic daTa - FACT project:
- Boero, Riccardo. 2024. “Fine scAle eConomic daTa - FACT.” OSF. [doi:10.17605/OSF.IO/PV4ZW](https://doi.org/10.17605/OSF.IO/PV4ZW).
using Documenter
using JuliaKubernetesClient
makedocs(
sitename = "Julia Kubernetes Client",
modules = [JuliaKubernetesClient],
format = Documenter.HTML(
repolink = "https://git.nilu.no/fact/utils/JuliaKubernetesClient.jl.git"
),
repo = "https://git.nilu.no/fact/utils/JuliaKubernetesClient.jl.git"
)
# API Reference
```@autodocs
Modules = [JuliaKubernetesClient]
Private
Order = [:function, :type]
```
```@docs
JuliaKubernetesClient.DOCKER_API_URL
JuliaKubernetesClient.JuliaKubernetesClient
```
# Documentation
Contents:
- [API Reference](api.md)
using Test
using JuliaKubernetesClient
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment