add action params

Author: anton.voskresensky

Dockerfile

@@ -32,8 +32,12 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         mtr-tiny \
         && rm -rf /var/lib/apt/lists/*
 
-COPY --from=builder /app/osctl /usr/local/bin/osctl
+RUN mkdir -p /app/osctl
 
-RUN chmod +x /usr/local/bin/osctl
+COPY --from=builder /app/osctl /app/osctl
 
-CMD ["/usr/local/bin/osctl"]
+RUN chmod +x /app/osctl
+
+ENV PATH="/app:${PATH}"
+
+CMD ["/app/osctl"]

ENVIRONMENT_VARIABLES_AND_FLAGS.md

@@ -17,6 +17,7 @@
 
 | Флаг | Переменная окружения | Описание | Значение по умолчанию |
 |------|---------------------|----------|--------------|
+| `--action` | `OSCTL_ACTION` | Автоматически выполнить команду (snapshot, retention, dereplicator, etc.) | (пусто) |
 | `--config` | `OSCTL_CONFIG` | Путь к файлу конфигурации | `config.yaml` |
 | `--os-url` | `OPENSEARCH_URL` | URL OpenSearch | `https://opendistro:9200` |
 | `--os-recoverer-url` | `OPENSEARCH_RECOVERER_URL` | URL OpenSearch Recoverer | `https://opendistro-recoverer:9200` |
@@ -35,6 +36,42 @@
 | `--dry-run` | `DRY_RUN` | Показать что будет сделано без выполнения | `false` |
 | `--snap-repo` | `SNAPSHOT_REPOSITORY` | Название репо для снапшотов | (пусто) |
 
+## Параметр action
+
+Параметр `action` позволяет автоматически выполнить нужную команду без указания её в командной строке. Сделано для деплойментов и кронджоб в Kubernetes.
+
+### Доступные значения action:
+- `snapshot` - Создание снапшотов индексов
+- `snapshot-manual` - Ручное создание снапшотов
+- `snapshotdelete` - Удаление старых снапшотов
+- `snapshotchecker` - Проверка отсутствующих снапшотов
+- `indicesdelete` - Удаление старых индексов
+- `retention` - Управление дисковым пространством
+- `dereplicator` - Уменьшение реплик для старых индексов
+- `coldstorage` - Перемещение индексов в холодное хранилище
+- `extracteddelete` - Удаление извлеченных индексов
+- `danglingchecker` - Проверка висячих индексов
+
+### Примеры использования:
+
+**В config.yaml:**
+```yaml
+action: "snapshot"
+opensearch_url: "https://opendistro:9200"
+# остальные настройки...
+```
+
+**Через переменную окружения:**
+```bash
+export OSCTL_ACTION=retention
+osctl
+```
+
+**Через флаг:**
+```bash
+osctl --action=snapshot
+```
+
 ## Флаги команд
 
 ### `coldstorage`
@@ -102,6 +139,3 @@
 | `--snapshot-manual-value` | `SNAPSHOT_VALUE` | Значение паттерна | (пусто) |
 | `--snapshot-manual-name` | `SNAPSHOT_NAME` | Имя снапшота (обязательно для regex) | (пусто) |
 | `--snapshot-manual-system` | `SNAPSHOT_SYSTEM` | Флаг системного индекса (получает индексы с точкой, независимо от даты) | `false` |
-| `--snapshot-manual-days-count` | `SNAPSHOT_DAYS_COUNT` | Какое количество дней держать индекс | `7` |
-| `--snapshot-manual-count-s3` | `SNAPSHOT_COUNT_S3` | Какое количество дней хранить снапшот в S3 | `14` |
-

README.md

@@ -1,20 +1,33 @@
 # osctl - Инструмент управления жизненным циклом индексов и снапшотов OpenSearch
 
-По-умолчанию предполагается использование `config.yaml` в котором описаны параметры запуска, а также указание конкретной команды, которая будет выполнять действие. Для некоторых действий также требуется файлик osctlindicesconfig.yaml ( пример в config-example) с описанием паттернов индексов и числом дней хранения.
+По-умолчанию предполагается использование `config.yaml` в котором описаны параметры запуска. Для автоматического выполнения команд можно использовать параметр `action`.
 
-```bash
-osctl snapshot
+Все, что указано в конфгиах можно переопределять через флаги, а также большинство команд поддерживают `--dry-run`.
 
-osctl snapshot-manual --snapshot-manual-kind=prefix --snapshot-manual-value=prod --snapshot-manual-days-count=14
+## Быстрый старт
 
-osctl retention --retention-threshold=75 --snap-repo=s3-backup
-osctl dereplicator --dereplicator-days-count=7 --dereplicator-use-snapshot
+### Использование с параметром action (рекомендуется)
+```bash
+# Создать config.yaml с нужной командой
+cat > config.yaml << EOF
+action: "snapshot"
+opensearch_url: "https://your-opensearch:9200"
+cert_file: "/path/to/cert.pem"
+key_file: "/path/to/key.pem"
+ca_file: "/path/to/ca.pem"
+EOF
+
+# Запустить osctl - команда выполнится автоматически
+osctl
+```
 
-osctl extracteddelete --days=7
-osctl coldstorage --hot-count=7 --cold-attribute=cold
+### Вариант использования через команды и флаги
+```bash
+osctl snapshot --config=config.yaml --osctl-indices-config=osctlindicesconfig.yaml
+osctl snapshotdelete --dry-run
 ```
 
-## Команды
+## Доступные команды (action)
 
 | Команда | Назначение |
 |---------|------------|
@@ -37,7 +50,7 @@ osctl coldstorage --hot-count=7 --cold-attribute=cold
 
 ### Конфигурация индексов (`osctlindicesconfig.yaml`)
 
-Пример в `osctlindicesconfig.yaml`
+Пример в `config-example/osctlindicesconfig.yaml`
 
 ## Приоритет конфигурации
 

commands/root.go

@@ -5,6 +5,7 @@ import (
 	"osctl/pkg/config"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 )
 
 var rootCmd = &cobra.Command{
@@ -26,6 +27,37 @@ Available Commands:
   datasource        Create Kibana data sources
   coldstorage       Migrate indices to cold storage nodes
   extracteddelete   Delete extracted indices that are no longer needed`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+
+		actionFlag, _ := cmd.Flags().GetString("action")
+		if actionFlag != "" {
+			if err := config.ValidateAction(actionFlag); err != nil {
+				fmt.Printf("Error: %v\n", err)
+				return err
+			}
+
+			if err := config.LoadConfig(cmd, "root"); err != nil {
+				fmt.Printf("Error: Could not load config: %v\n", err)
+				return err
+			}
+			return executeActionCommand(actionFlag, args)
+		}
+
+		if err := config.LoadConfig(cmd, "root"); err != nil {
+			fmt.Printf("Error: Could not load config: %v\n", err)
+			return err
+		}
+		cfg := config.GetConfig()
+		if cfg.Action != "" {
+			if err := config.ValidateAction(cfg.Action); err != nil {
+				fmt.Printf("Error: %v\n", err)
+				return err
+			}
+			return executeActionCommand(cfg.Action, args)
+		}
+
+		return cmd.Help()
+	},
 }
 
 func Execute() error {
@@ -46,7 +78,53 @@ func Execute() error {
 	return rootCmd.Execute()
 }
 
+func executeActionCommand(action string, args []string) error {
+
+	var targetCmd *cobra.Command
+
+	switch action {
+	case "snapshot":
+		targetCmd = snapshotCmd
+	case "snapshot-manual":
+		targetCmd = snapshotManualCmd
+	case "snapshotdelete":
+		targetCmd = snapshotDeleteCmd
+	case "snapshotchecker":
+		targetCmd = snapshotCheckerCmd
+	case "indicesdelete":
+		targetCmd = indicesDeleteCmd
+	case "retention":
+		targetCmd = retentionCmd
+	case "dereplicator":
+		targetCmd = dereplicatorCmd
+	case "coldstorage":
+		targetCmd = coldStorageCmd
+	case "extracteddelete":
+		targetCmd = extractedDeleteCmd
+	case "danglingchecker":
+		targetCmd = danglingCheckerCmd
+	default:
+		return fmt.Errorf("unknown action: %s", action)
+	}
+
+	targetCmd.SetArgs(args)
+
+	newCmd := &cobra.Command{
+		Use:   targetCmd.Use,
+		Short: targetCmd.Short,
+		Long:  targetCmd.Long,
+		RunE:  targetCmd.RunE,
+	}
+
+	targetCmd.Flags().VisitAll(func(flag *pflag.Flag) {
+		newCmd.Flags().AddFlag(flag)
+	})
+
+	return newCmd.Execute()
+}
+
 func init() {
+	addFlags(rootCmd)
 	rootCmd.AddCommand(snapshotCmd)
 	rootCmd.AddCommand(snapshotManualCmd)
 	rootCmd.AddCommand(snapshotDeleteCmd)
@@ -63,6 +141,7 @@ func init() {
 }
 
 func addFlags(cmd *cobra.Command) {
+	cmd.PersistentFlags().String("action", "", "Action to execute (snapshot, retention, dereplicator, etc.)")
 	cmd.PersistentFlags().String("config", "", "Path to configuration file")
 	cmd.PersistentFlags().String("os-url", "", "OpenSearch URL")
 	cmd.PersistentFlags().String("cert-file", "", "Certificate file path")

commands/snapshotmanual.go

@@ -33,8 +33,6 @@ func runSnapshotManual(cmd *cobra.Command, args []string) error {
 	value := cfg.SnapshotManualValue
 	name := cfg.SnapshotManualName
 	system, _ := strconv.ParseBool(cfg.SnapshotManualSystem)
-	daysCount, _ := strconv.Atoi(cfg.SnapshotManualDaysCount)
-	snapshotCountS3, _ := strconv.Atoi(cfg.SnapshotManualCountS3)
 
 	if value == "" {
 		return fmt.Errorf("value is required")
@@ -44,7 +42,7 @@ func runSnapshotManual(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("name is required for regex patterns")
 	}
 
-	logger.Info(fmt.Sprintf("Starting manual snapshot creation kind=%s value=%s name=%s system=%t daysCount=%d snapshotCountS3=%d", kind, value, name, system, daysCount, snapshotCountS3))
+	logger.Info(fmt.Sprintf("Starting manual snapshot creation kind=%s value=%s name=%s system=%t daysCount=%d snapshotCountS3=%d", kind, value, name, system))
 
 	client, err := opensearch.NewClient(cfg.OpenSearchURL, cfg.CertFile, cfg.KeyFile, cfg.CAFile, cfg.GetTimeout(), cfg.GetRetryAttempts())
 	if err != nil {

config-example/deployments-examples.yaml

@@ -0,0 +1,44 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: osctl-snapshot
+  namespace: infra-elklogs
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: osctl-snapshot
+  template:
+    metadata:
+      labels:
+        app: osctl-snapshot
+    spec:
+      containers:
+      - name: osctl-snapshot
+        image: ghcr.io/flant/osctl:latest
+        volumeMounts:
+        - mountPath: /app/config.yaml
+          name: config
+          subPath: config.yaml
+        - mountPath: /app/osctlindicesconfig.yaml
+          name: config
+          subPath: osctlindicesconfig.yaml
+        - mountPath: /etc/ssl/certs/elk-crt.pem
+          name: certs
+          readOnly: true
+          subPath: elk-crt.pem
+        - mountPath: /etc/ssl/certs/elk-key.pem
+          name: certs
+          readOnly: true
+          subPath: elk-key.pem
+        - mountPath: /etc/ssl/certs/elk-root-ca.pem
+          name: certs
+          readOnly: true
+          subPath: elk-root-ca.pem
+      volumes:
+      - name: config
+        configMap:
+          name: osctl-config
+      - name: certs
+        secret:
+          secretName: opendistro-tls-data