diff --git a/DEVEL.md b/DEVEL.md new file mode 100644 index 0000000..564d10a --- /dev/null +++ b/DEVEL.md @@ -0,0 +1,37 @@ + +Данный сервис был написан мной в целях представить простой в развертывании, модификации и использовании сервис хранения артефактов. +Прежде всего образов контейнеров и helm charts. Я не претендовал на +коммерческий продукт в широком публичном испльзовании. + +Он успешно испытан при создании k8s кластеров и развертывании приложений в нем. + +В этом продукте представлено три условных протокола взаимодействия + +1 Это протокол передачи компонент образов контейнеров, +выросший из протокола, придуманном неким человеком в Docker.com. +У меня много вопросов к нему (к ним?). И предполагаю что некоторые будут +содержать преимуществнно обсценную лекcику, к которой пришел +в процессе реализации протокола. + +Предволожительно и по содержанию первой версии docker сервиса, +это протокол, созданный начинающим в професиии человеком и знающим только HTTP. +Но интегрированный в деловые процессы он стал основой де-факто, +судя по всему без значительных попыток пересмотра. + +Позднее этот протокол был несколько облагорожен и получил статус и редакцию +стандарта от Open Container Initiative. + +Его реализации разнятся по содержанию и поведению, и по моим приблизительным оценкам, +совпадают с опубликованными спецификациями где-то на две трети, +даже в части обязательных указаний. + +2 Созданнный в стиле первого, протокол передачи файлов и чартов. Фактически +ограничен реализацией протокола в утилите helm. + +3 Протол управления аккаунтами и разрешениями сервиса. Он сделан по мотивам +JSON RPC и относительно независим от транспортной среды. Относительно незавивисим, +поскольку тип субьекта и операция с ним кодируются в пути запроса. +Этот подход с одной стороны относительно привычен для многих. +С другой стороны, мы не ограничены параметрами запросов и ответов, и ограничены +только границами json формализмов и сериализации. + diff --git a/docs/main.go b/docs/main.go deleted file mode 100644 index 86dfe07..0000000 --- a/docs/main.go +++ /dev/null @@ -1,49 +0,0 @@ -package main - -import ( - "fmt" - "time" - "os" - - "github.com/spf13/cobra/doc" - - "mstore/cmd/mstorectl/command" -) - -func run() error { - var err error - os.Args[0] = "mstorectl" - util := command.NewUtil() - err = util.Build() - if err != nil { - return err - } - - cmd := util.GetRooCmd() - now := time.Now() - header := &doc.GenManHeader{ - Title: "mstore", - Section: "1", - Manual: "User commands", - Source: "mstorectl command", - Date: &now, - } - opts := doc.GenManTreeOptions { - Header: header, - Path: "./", - CommandSeparator: "-", - } - err = doc.GenManTreeFromOpts(cmd, opts) - if err != nil { - return err - } - return err -} - -func main() { - err := run() - if err != nil { - fmt.Printf("err: %v\n", err) - } - -} diff --git a/docs/mstore.drawio b/docs/mstore.drawio new file mode 100644 index 0000000..cb16faa --- /dev/null +++ b/docs/mstore.drawio @@ -0,0 +1,85 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/mstore.png b/docs/mstore.png new file mode 100644 index 0000000..9e12d4b Binary files /dev/null and b/docs/mstore.png differ