cascade/git-remote-k8s
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated instructions

Browse Source
This commit is contained in:
James Andariese 2023-10-31 04:41:10 -05:00
parent 07d0474ba1
commit 210f9aab38
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -5,12 +5,11 @@ git repo storage.
## Installation ## Installation
Assuming you have `$HOME/bin` in your `$PATH`, you may use the following command to install First, install Rust.
`git-remote-k8s`. It must be named `git-remote-k8s` (without the .sh), be executable, and
be in your PATH to work.
Now, from within the cloned repo, install git-remote-k8s
```bash ```bash
ln -sf $PWD/git-remote-k8s.sh $HOME/bin/git-remote-k8s cargo install --path .
``` ```
## Prerequisites ## Prerequisites

11
src/main.rs
View File

@ -10,6 +10,7 @@
// * config mode (maybe) // * config mode (maybe)
// * set the pvc storageclass instead // * set the pvc storageclass instead
use std::f32::consts::E; use std::f32::consts::E;
use std::process::ExitCode; use std::process::ExitCode;
use std::time::Duration; use std::time::Duration;
@ -44,6 +45,12 @@ static REMOTE_PATTERN: Lazy<regex::Regex> = Lazy::new(|| {regex::Regex::new(&for
mod test; mod test;
#[derive(ClapParser, Debug, Clone)] #[derive(ClapParser, Debug, Clone)]
/// git-remote-k8s
///
/// This should usually be run by git. You can set git up to use it
/// by running git remote add k k8s://default/ns/repo.
///
/// see https://git.strudelline.net/cascade/git-remote-k8s for more info
struct Config { struct Config {
#[arg( #[arg(
short, short,
@ -79,9 +86,7 @@ struct Config {
/// storageClassName to use for the backing PVC _if it is created_. /// storageClassName to use for the backing PVC _if it is created_.
/// ///
/// this will be used to create a new PVC but if a PVC already /// this will be used to create a new PVC but if a PVC already
/// exists by the requested name, it will be used. If there is /// exists by the requested name, it will be used.
/// no repo present in the PVC, one will be created on the first
/// run.
storageclass: Option<String>, storageclass: Option<String>,
#[arg(short('s'),long("initial-volume-size"), default_value("1Gi"), env="GIT_REMOTE_K8S_INITIAL_VOLUME_SIZE")] #[arg(short('s'),long("initial-volume-size"), default_value("1Gi"), env="GIT_REMOTE_K8S_INITIAL_VOLUME_SIZE")]