kubernetes / git-sync

A sidecar app which clones a git repo and keeps it in sync with the upstream.
Apache License 2.0
2.22k stars 411 forks source link

Update README.md For Environment Variables #770

Closed vyusufcan closed 1 year ago

vyusufcan commented 1 year ago

Hello,

When i try to set environment variable for git-sync , i noticed that the values ​​written in the documentation does not work.

For example ;

$GITSYNC_ROOT should be $GIT_SYNC_ROOT


  --root <string>, $GITSYNC_ROOT
              The root directory for git-sync operations, under which --link will
              be created.  This must be a path that either a) does not exist (it
              will be created); b) is an empty directory; or c) is a directory
              which can be emptied by removing all of the contents.  This flag is
              required.

$GITSYNC_SYNC_TIMEOUT should be $GIT_SYNC_SYNC_TIMEOUT


    --sync-timeout <duration>, $GITSYNC_SYNC_TIMEOUT
            The total time allowed for one complete sync.  This must be at least
            10ms.  This flag obsoletes --timeout, but if --timeout is specified,
            it will take precedence.  If not specified, this defaults to 120
            seconds ("120s").

I can update the README.md to fix environment variables.

thockin commented 1 year ago

The doc (master branch) covers v4. I presume you are using v3. V4 will accept v3 var names, but not vice-versa.

On Tue, Jul 18, 2023, 6:02 AM vehbi yusuf can @.***> wrote:

Hello,

When i try to set environment variable for git-sync , i noticed that the values ​​written in the documentation does not work.

For example ;

$GITSYNC_ROOT should be $GIT_SYNC_ROOT

--root , $GITSYNC_ROOT The root directory for git-sync operations, under which --link will be created. This must be a path that either a) does not exist (it will be created); b) is an empty directory; or c) is a directory which can be emptied by removing all of the contents. This flag is required.

$GITSYNC_SYNC_TIMEOUT should be $GIT_SYNC_SYNC_TIMEOUT

--sync-timeout <duration>, $GITSYNC_SYNC_TIMEOUT
        The total time allowed for one complete sync.  This must be at least
        10ms.  This flag obsoletes --timeout, but if --timeout is specified,
        it will take precedence.  If not specified, this defaults to 120
        seconds ("120s").

I can update the README.md to fix environment variables.

— Reply to this email directly, view it on GitHub https://github.com/kubernetes/git-sync/issues/770, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABKWAVFJ3PO3VPHLZ7SKQK3XQ2CNJANCNFSM6AAAAAA2OLYF5I . You are receiving this because you are subscribed to this thread.Message ID: @.***>