Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

object & secret store config naming changes for consistency #206

Merged
merged 4 commits into from
Feb 6, 2023

Conversation

joeshaw
Copy link
Member

@joeshaw joeshaw commented Nov 16, 2022

object_store becomes object_stores for consistency with backends
and dictionaries. path becomes file for consistency with
dictionaries and geolocation config.

An example object store in the fastly.toml file might now look something
like:

[local_server]
object_stores.store_one = [{key = "one", file = "/path/to/something"}]

or

[local_server]
[local_server.object_stores]
store_one = [{key = "one", file = "/path/to/something"}]

or

[local_server]
[local_server.object_stores]
[[local_server.object_stores.store_one]]
key = "one"
file = "/path/to/something"

Backwards compatibility is maintained.

The Secret Store is updated to match the new Object Store conventions, but backwards compatibility is not maintained (because it's brand new and doesn't need to be).

@joeshaw joeshaw closed this Jan 20, 2023
@joeshaw
Copy link
Member Author

joeshaw commented Feb 3, 2023

Going to work on this again, try to maintain compatibility and move secret store over as well.

@joeshaw joeshaw reopened this Feb 3, 2023
`object_store` becomes `object_stores` for consistency with `backends`
and `dictionaries`.  `path` becomes `file` for consistency with
dictionaries and geolocation config.

An example object store in the fastly.toml file might now look something
like:

```
[local_server]
object_stores.store_one = [{key = "one", file = "/path/to/something"}]
```

or

```
[local_server]
[local_server.object_stores]
store_one = [{key = "one", file = "/path/to/something"}]
```

or

```
[local_server]
[local_server.object_stores]
[[local_server.object_stores.store_one]]
key = "one"
file = "/path/to/something"
```
object_store is an alias for object_stores
path is an alias for file
This makes it consistent with object store and other sections
@joeshaw joeshaw changed the title object store config naming changes for consistency object & secret store config naming changes for consistency Feb 3, 2023
joeshaw added a commit to fastly/cli that referenced this pull request Feb 3, 2023
`object_store` becomes `object_stores`
`secret_store` becomes `secret_stores`
`path` becomes `file`

This makes these more consistent with other parts of the manifest like
dictionaries, backends, geolocation, etc.

Companion to fastly/Viceroy#206
joeshaw added a commit to fastly/cli that referenced this pull request Feb 3, 2023
`object_store` becomes `object_stores`
`secret_store` becomes `secret_stores`
`path` becomes `file`

This makes these more consistent with other parts of the manifest like
dictionaries, backends, geolocation, etc.

Companion to fastly/Viceroy#206
@joeshaw joeshaw merged commit e12d184 into main Feb 6, 2023
@joeshaw joeshaw deleted the joeshaw/object-store-naming branch February 6, 2023 16:00
@itsrainy itsrainy mentioned this pull request Mar 17, 2023
@Integralist
Copy link
Contributor

Integralist commented Apr 12, 2023

👋🏻 @JakeChampion @joeshaw

I noticed on https://developer.fastly.com/reference/compute/fastly-toml/#local-server it still says path and not file (as the CLI was updated to use file in the toml parsing/lookup).

Is this just a case of the documentation has been neglected or did something change since this PR (and the CLI PR) were merged?

I just went to the documentation to see how to setup a local object_store and noticed the code in the CLI would fail to parse path.

UPDATE: Just familiarising myself with the CLI code and I'm not sure it matters as far as the CLI is concerned because the local_server configuration in the CLI isn't used by the CLI (from what I can tell), the CLI just passes in the fastly.toml path to Viceroy.

@JakeChampion
Copy link
Contributor

JakeChampion commented Apr 12, 2023

Is this just a case of the documentation has been neglected or did something change since this PR (and the CLI PR) were merged?

We didn't get around to the changes for the developer portal -- file is the new name and is staying around 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants