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

Deprecate datasources and promote the flux_bootstrap_git docs #444

Merged
merged 5 commits into from
Apr 11, 2023

Conversation

phillebaba
Copy link
Member

@phillebaba phillebaba commented Apr 6, 2023

This change deprecates the flux_install and flux_sync datasource. It adds a deprecation notice to the datasources and moves the guides to a deprecated sub category.

Also:

  • updates the provider versions in examples and docs use the RC version as per the docs

Prerelease versions are supported (available if explicitly defined but not chosen automatically) with a hyphen (-) delimiter, such as v1.2.3-pre.

  • renames the deprecated guides with new alternatives to indicate deprecated version
  • fixes the strange file name for new github guide in the registry
    navigation panel by fixing the frontmatter yaml. Because of invalid
    yaml, the renderer was using the file name as the page name in the
    navigation panel. This issue was also being highlighted in the github
    markdown render as:
Error in user YAML: (<unknown>): found a tab character where an
intendation space is expected while scanning a block scalar at line 3 column 14

Based on the docs

If a page_title attribute is not found, the title will default to the filename without the extension.

Part of: #426

@phillebaba phillebaba force-pushed the deprecate/datasource branch from f2502bc to df8f051 Compare April 6, 2023 18:59
@phillebaba phillebaba requested a review from stefanprodan April 6, 2023 19:59
@stefanprodan
Copy link
Member

stefanprodan commented Apr 6, 2023

I think we should also rename the guides: github.md, gitlab.md and customise.md should contain the updated docs, otherwise Google will point people to old docs.

phillebaba and others added 3 commits April 11, 2023 18:13
Signed-off-by: Philip Laine <[email protected]>
- Rename and update the files in the template directory as per the
  updates to the guide docs in the previous commit.
- Fix the strange file name for new github guide in the registry
  navigation panel by fixing the frontmatter yaml. Because of invalid
  yaml, the renderer was using the file name as the page name in the
  navigation panel. This issue was also being highlighted in the github
  markdown render as:

```
Error in user YAML: (<unknown>): found a tab character where an
intendation space is expected while scanning a block scalar at line 3 column 14
```

Signed-off-by: Sunny <[email protected]>
@darkowlzz darkowlzz force-pushed the deprecate/datasource branch from 3e9b995 to a8b9fd6 Compare April 11, 2023 13:17
Since it's a prerelease, update the examples and docs to explicitly use
the RC version.

Signed-off-by: Sunny <[email protected]>
@stefanprodan stefanprodan changed the title Deprecate datasources Deprecate datasources and promote the flux_bootstrap_git docs Apr 11, 2023
@phillebaba
Copy link
Member Author

The reason the tests are not passing is because provider dev overrides does not apply to init. Meaning it will annoyingly try to resolve the version of the Flux provider which does not exist.

@stefanprodan
Copy link
Member

Is there a fix or should we merge it like this?

@darkowlzz darkowlzz force-pushed the deprecate/datasource branch 7 times, most recently from 158fb83 to 6f8cb29 Compare April 11, 2023 16:07
Using the version of the provider that's not published from the example
configuration in e2e test fails because `terraform init` queries the
upstream terraform registry for the same version and fails when the
upstream returns an error, as it's unpublished. Remove the version field
from the example configuration to avoid this failure. The
`dev_overrides` in .terraformrc will make sure that the e2e test uses
the local provider instead of the downloaded old provider.

Signed-off-by: Sunny <[email protected]>
@darkowlzz darkowlzz force-pushed the deprecate/datasource branch from 6f8cb29 to 92a95ba Compare April 11, 2023 16:13
@darkowlzz
Copy link
Contributor

Is there a fix or should we merge it like this?

Discussed with @phillebaba about it and decided to remove the version field from the example that's used in the e2e test. All the other examples continue to have the version.
For the record, the alternative of using a local mirror + dev overrides works but that may be future unintended consequences and just removing the version is a simpler workaround for the issue at present.

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks @phillebaba and @darkowlzz

@darkowlzz darkowlzz merged commit 262df96 into main Apr 11, 2023
@darkowlzz darkowlzz deleted the deprecate/datasource branch April 11, 2023 16:32
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.

3 participants