gitignore config.yml (elastic#2280)

wangch079 · Mar 25, 2024 · a3c9eff · a3c9eff
1 parent cc56cb6
commit a3c9eff
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,9 @@ pyvenv.cfg
 *.egg-info
 __pycache__
 
+# real configurations
+config.yml
+
 # jetbrains files
 .idea
 *.iml

diff --git a/Makefile b/Makefile
@@ -7,7 +7,10 @@ SLOW_TEST_THRESHOLD=1 # seconds
 VERSION=$(shell cat connectors/VERSION)
 
 
-bin/python:
+config:
+	- cp -n config.yml.example config.yml
+
+bin/python: config
 	$(PYTHON) -m venv .
 	bin/pip install --upgrade pip
 

diff --git a/config.yml → config.yml.example b/config.yml → config.yml.example
diff --git a/docs/CONFIG.md b/docs/CONFIG.md
@@ -1,6 +1,8 @@
 # Configuration
 
-Configuration lives in [config.yml](../config.yml).
+Configuration lives in `config.yml`.
+This file is created when you first run `make install`, and is "git ignored" to help prevent committing secrets.
+The default configs can all be seen in the [`config.yml.example`]((../config.yml.example).), which is not intended to be modified.
 
 ## Run the connector service on-prem
 

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -66,7 +66,7 @@ Enhancements that can be done after your initial contribution:
 
 To make sure we're building great connectors, we will be pretty strict on this checklist, and we will not allow connectors to change the framework code itself.
 
-Any patch with changes outside [connectors/sources](../connectors/sources) or [config.yml](../config.yml) and [requirements.txt](../requirements.txt) will be rejected.
+Any patch with changes outside [connectors/sources](../connectors/sources) or [config.yml.example](../config.yml.example) and [requirements.txt](../requirements.txt) will be rejected.
 
 If you need changes in the framework, or you are not sure about how to do something, reach out to the [Ingestion team](https://github.com/orgs/elastic/teams/ingestion-team/members) and/or file an issue.
 

diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
@@ -26,7 +26,7 @@
 
 ## General Configuration
 
-The details of Elastic instance and other relevant fields such as `service` and `source` needs to be provided in the [config.yml](https://github.com/elastic/connectors/blob/main/config.yml) file. For more details check out the following [documentation](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
+The details of Elastic instance and other relevant fields such as `service` and `source` needs to be provided in the `config.yml` file. For more details check out the following [documentation](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
 
 ## Installation
 
@@ -64,7 +64,7 @@ That information is provided by Kibana and follows the [connector protocol](http
 
 When a user asks for a sync of a specific source, the service instantiates a class that it uses to reach out the source and collect data.
 
-A source class can be any Python class, and is declared into the [configuration](../config.yml) file (See [Configuration](./CONFIG.md) for detailed explanation). For example:
+A source class can be any Python class, and is declared into the `config.yml` file (See [Configuration](./CONFIG.md) for detailed explanation). For example:
 
 ```yaml
 sources:

diff --git a/docs/DOCKER.md b/docs/DOCKER.md
@@ -35,7 +35,7 @@ cd ~ && mkdir connectors-config
 You can download the file manually, or simply run the command below. Make sure to update the `--output` argument value if your directory name is different, or you want to use a different config file name.
 
 ```sh
-curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml --output ~/connectors-config/config.yml
+curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml
 ```
 
 ## 4. Update the configuration file for your [self-managed connector](https://www.elastic.co/guide/en/enterprise-search/current/build-connector.html#build-connector-usage)

diff --git a/scripts/stack/README.md b/scripts/stack/README.md
@@ -33,7 +33,7 @@ Note that this method of setting the password, or using the default password, is
 This can include editing the `docker-compose.yml` file and the `set-env.sh` script to hardcode a different password amongst other ways.
 
 Alternatively, if you do not wish to use a different set of credentials, or an API key for authentication, you can run the `./copy-config.sh` script to create a
-copy of the default [config.yml](../../config.yml) file, and edit the resulting file that will be created in the `scripts/stack/connectors-config` folder.
+copy of the default [config.yml.example](../../config.yml.example) file, and edit the resulting file that will be created in the `scripts/stack/connectors-config` folder.
 
 By default, these Connector scripts will use a `SNAPSHOT` version of the Docker image.
 The version is defined in the [VERSION file](../../connectors/VERSION).